Accounts

Modify the account identified by the accoutId

put/{spaceId}/accounts/{accountId}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/accounts/{accountId}
  • 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
accountIdstring required

Request body

AccountIdstring required
Descriptionstring
EnvironmentIdsstring[]
Namestring required
Slugstring
SpaceIdstring required
TenantedDeploymentParticipationstring
TenantIdsstring[]
TenantTagsstring[]

Example request

{
  "AccountId": "Accounts-1",
  "EnvironmentIds": [
    "Environments-1",
    "..."
  ],
  "SpaceId": "Spaces-1",
  "TenantIds": [
    "Tenants-1",
    "..."
  ]
}

Response

The resource returned from modifying an account

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

No recorded changes to this operation across all 13 revisions of this API.