Aliases

Quick Navigation

GET Aliases

Returns a list of requestable Managed Account Aliases.

Requestor or Requestor/Approver role for the preferred Managed Account referenced by the Alias.

  • state (optional, default: 1, 2): Zero or more state values, i.e 'state=2', 'state=1,2', 'state=0,1,2'.
    • 0 - Unmapped
    • 1 - Mapped
    • 2 - Highly Available

Only Aliases with a mapped state of 1 or 2 can be used for API 'POST Aliases/{id}/Requests'.

None

Content-Type: application/json

[
    {
        AliasId: int,
        AliasName: string,
        AliasState: int,
        SystemId: int,
        SystemName: string,
        AccountId: int,
        AccountName: string,
        DomainName: string,
        InstanceName: string,
        DefaultReleaseDuration: int,
        MaximumReleaseDuration: int,
        LastChangeDate: datetime,
        NextChangeDate: datetime,
        IsChanging: bool,
        ChangeState: int,

        MappedAccounts :
        [
            {
                AliasID: int,
                ManagedSystemID: int,
                ManagedAccountID: int,
                Status: string
            },
            …
        ]
    }
    …
]

200 - Request successful. Aliases in response body.

For more information, please see Common Response Codes.

GET Aliases/{id}

Returns a requestable Managed Account Alias by ID.

Requestor or Requestor/Approver role for the preferred Managed Account referenced by the Alias.

id: ID of the Managed Account Alias.

None

Content-Type: application/json

{
    AliasId: int,
    AliasName: string,
    AliasState: int,
    SystemId: int,
    SystemName: string,
    AccountId: int,
    AccountName: string,
    DomainName: string,
    InstanceName: string,
    DefaultReleaseDuration: int,
    MaximumReleaseDuration: int,
    LastChangeDate: datetime,
    NextChangeDate: datetime,
    IsChanging: bool,
    ChangeState: int,

    MappedAccounts :
    [
        {
            AliasID: int,
            ManagedSystemID: int,
            ManagedAccountID: int,
            Status: string
        },
        …
    ]
}

200 - Request successful. Alias in response body.

For more information, please see Common Response Codes.

GET Aliases?name={name}

Returns a requestable Managed Account Alias by name.

Requestor or Requestor/Approver role for the preferred Managed Account referenced by the Alias.

name: Name of the Managed Account Alias.

None

Content-Type: application/json

{
    AliasId: int,
    AliasName: string,
    AliasState: int,
    SystemId: int,
    SystemName: string,
    AccountId: int,
    AccountName: string,
    DomainName: string,
    InstanceName: string,
    DefaultReleaseDuration: int,
    MaximumReleaseDuration: int,
    LastChangeDate: datetime,
    NextChangeDate: datetime,
    IsChanging: bool,
    ChangeState: int,

    MappedAccounts :
    [
        {
            AliasID: int,
            ManagedSystemID: int,
            ManagedAccountID: int,
            Status: string
        },
        …
    ]
}

200 - Request successful. Alias in response body.

For more information, please see Common Response Codes.