Accounts

Get a list of Accounts

Lists all of the accounts in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.

get/{spaceId}/accounts/all

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/accounts/all
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdstring required

The ID of the space containing the resource(s).

Response

The requested list of Accounts

AccountType'AmazonWebServicesAccount' | 'AmazonWebServicesOidcAccount' | 'AzureOidc' | 'AzureServicePrincipal' | 'AzureSubscription' | 'GenericOidcAccount' | 'GoogleCloudAccount' | 'GoogleCloudOidcAccount' | 'None' | 'SshKeyPair' | 'Token' | 'UsernamePassword'
Descriptionstring
EnvironmentIdsstring[]
Idstring

Gets or sets a unique identifier for this resource.

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

Namestring
Slugstring
SpaceIdstring
TenantedDeploymentParticipation'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'
TenantIdsstring[]
TenantTagsstring[]

Example response

[
  {
    "EnvironmentIds": [
      "Environments-1",
      "..."
    ],
    "Links": {
      "Self": "/api/..."
    },
    "SpaceId": "Spaces-1",
    "TenantIds": [
      "Tenants-1",
      "..."
    ]
  }
]

Changes