Certificates

Modify a certificate by ID

Modifies an existing certificate

put/spaces/{spaceIdentifier}/certificates/{id}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/certificates/{id}
  • 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

spaceIdentifierstring required

Identifier (ID or slug) of the space

idstring required

The ID of the certificate

Request body

EnvironmentIdsstring[]

The environments allowed to use this certificate

Idstring required

The ID of the certificate

Namestring required

The name of the certificate

Notesstring

Additional information on the certificate

SpaceIdstring required

The ID of the space

TenantedDeploymentParticipation'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'

The kind of deployments where this certificate should be included

TenantIdsstring[]

The tenants this certificate should be associated with

TenantTagsstring[]

The tags this certificate should be associated with

Example request

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

Response

The modified certificate resource

Archivedstring date-time
CertificateDataFormat'Pkcs12' | 'Der' | 'Pem' | 'Unknown'
EnvironmentIdsstring[]
HasPrivateKeyboolean
Idstring

Gets or sets a unique identifier for this resource.

IsExpiredboolean
IssuerCommonNamestring
IssuerDistinguishedNamestring
IssuerOrganizationstring
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
NotAfterstring date-time
NotBeforestring date-time
Notesstring
ReplacedBystring
SelfSignedboolean
SerialNumberstring
SignatureAlgorithmNamestring
SpaceIdstring
SubjectAlternativeNamesstring[]
SubjectCommonNamestring

The certificate subject's common name (CN). When creating a self-signed certificate this becomes the generated certificate's CN, and at least one of SubjectCommonName or SubjectOrganization must be supplied.

SubjectDistinguishedNamestring
SubjectOrganizationstring

The certificate subject's organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied.

TenantedDeploymentParticipation'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'
TenantIdsstring[]
TenantTagsstring[]
Thumbprintstring
Versioninteger

Example response

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

Changes