Certificates

Create a self-signed Certificate

post/{spaceId}/certificates/generate

Request

Base URL
https://demo.octopus.app/api
URL
https://demo.octopus.app/api/{spaceId}/certificates/generate
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

Request body

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

SelfSignedCertificateCurvestring

Elliptic curve for the generated key pair: nistP256, nistP384 or nistP521. Defaults to nistP384 when omitted.

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 request

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

Response

The newly-created self-signed Certificate.