PlatformHub

Create a self-signed Platform Hub certificate.

post/platformhub/certificates/generate

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/platformhub/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

Request body

Archivedstring date-time
CertificateDataFormat'Pkcs12' | 'Der' | 'Pem' | 'Unknown'
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
SerialNumberstring
SignatureAlgorithmNamestring
Slugstring

The slug of the certificate.

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.

Thumbprintstring
Versioninteger

Example request

{
  "Links": {
    "Self": "/api/..."
  }
}

Response

The created self-signed Platform Hub certificate.

Archivedstring date-time
CertificateDataFormat'Pkcs12' | 'Der' | 'Pem' | 'Unknown'
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
Slugstring

The slug of the certificate.

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.

Thumbprintstring
Versioninteger

Example response

{
  "Links": {
    "Self": "/api/..."
  }
}

Changes