Certificates

GET /api/{spaceId}/certificates

Also reachable at /api/certificates, /api/spaces/{spaceIdentifier}/certificates.

Path Parameters

• spaceId string (required)
  The ID of the space containing the resource(s).

Query Parameters

• archived boolean
  If true, returns only archived Certificates. Otherwise, returns only non-archived Certificates.
• firstResult string
  Certificate ID which if specified, adds the Certificate with matching ID to the result if it is not already included.
• ids string
  Comma delimited list of Certificate IDs which if specified, filters the result to only include Certificates with matching IDs.
• orderBy string
  If the value is ‘recent’ (case-insensitive), then the result will be sorted by Created instead of NotAfter.
• partialName string
  Alternative parameter to Search; filters Certificates by Name/Subject/Thumbprint.
• search string
  Filters Certificates by Name/Subject/Thumbprint.
• skip integer
  Number of items to skip. Defaults to zero. Minimum 0.
• take integer
  Number of items to take. Defaults to 15. Minimum 0.
• tenant string
  Tenant ID which if specified, filters the result to only include Certificates which are related to the provided Tenant.

Response

200 — The requested Certificates

• Id string
  Gets or sets a unique identifier for this resource.
• ItemType string
• Items array of object
  • Archived string
    Format date-time.
  • CertificateChain array of object
  • CertificateData sensitive value
  • CertificateDataFormat enum
    Allowed values: Pkcs12, Der, Pem, Unknown.
  • EnvironmentIds array of string
  • HasPrivateKey boolean
  • Id string
    Gets or sets a unique identifier for this resource.
  • IsExpired boolean
  • IssuerCommonName string
  • IssuerDistinguishedName string
  • IssuerOrganization string
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • Name string
  • NotAfter string
    Format date-time.
  • NotBefore string
    Format date-time.
  • Notes string
  • Password sensitive value
  • ReplacedBy string
  • SelfSigned boolean
  • SerialNumber string
  • SignatureAlgorithmName string
  • SpaceId string
  • SubjectAlternativeNames array of string
  • SubjectCommonName string
    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.
  • SubjectDistinguishedName string
  • SubjectOrganization string
    The certificate subject’s organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied.
  • TenantIds array of string
  • TenantTags array of string
  • TenantedDeploymentParticipation enum
    Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.
  • Thumbprint string
  • Version integer
• ItemsPerPage integer
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LastPageNumber integer
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• NumberOfPages integer
• TotalResults integer

{
  "Id": "string",
  "ItemType": "string",
  "Items": [
    {
      "Archived": "2020-01-01T00:00:00.000Z",
      "CertificateChain": [
        {}
      ],
      "CertificateData": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "CertificateDataFormat": "Pkcs12",
      "EnvironmentIds": [
        "string"
      ],
      "HasPrivateKey": true,
      "Id": "string",
      "IsExpired": true,
      "IssuerCommonName": "string",
      "IssuerDistinguishedName": "string",
      "IssuerOrganization": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "NotAfter": "2020-01-01T00:00:00.000Z",
      "NotBefore": "2020-01-01T00:00:00.000Z",
      "Notes": "string",
      "Password": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "ReplacedBy": "string",
      "SelfSigned": true,
      "SerialNumber": "string",
      "SignatureAlgorithmName": "string",
      "SpaceId": "string",
      "SubjectAlternativeNames": [
        "string"
      ],
      "SubjectCommonName": "string",
      "SubjectDistinguishedName": "string",
      "SubjectOrganization": "string",
      "TenantIds": [
        "string"
      ],
      "TenantTags": [
        "string"
      ],
      "TenantedDeploymentParticipation": "Untenanted",
      "Thumbprint": "string",
      "Version": 0
    }
  ],
  "ItemsPerPage": 0,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LastPageNumber": 0,
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "NumberOfPages": 0,
  "TotalResults": 0
}

POST /api/{spaceId}/certificates

Also reachable at /api/certificates, /api/spaces/{spaceIdentifier}/certificates.

Adds a new certificate

Path Parameters

• spaceId string (required)

Request Body

• CertificateData sensitive value (required)
  • HasValue boolean
  • Hint string
  • NewValue string
• EnvironmentIds array of string
• Name string (required)
  Minimum length 1.
• Notes string
  Maximum length 10240.
• Password sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• SpaceId string (required)
• TenantIds array of string
• TenantTags array of string
• TenantedDeploymentParticipation enum
  Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.

Response

201 — Created

• Archived string
  Format date-time.
• CertificateChain array of object
  • IssuerDistinguishedName string
  • NotAfter string
    Format date-time.
  • NotBefore string
    Format date-time.
  • SerialNumber string
  • SignatureAlgorithmName string
  • SubjectDistinguishedName string
  • Thumbprint string
  • Version integer
• CertificateData sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• CertificateDataFormat enum
  Allowed values: Pkcs12, Der, Pem, Unknown.
• EnvironmentIds array of string
• HasPrivateKey boolean
• Id string
  Gets or sets a unique identifier for this resource.
• IsExpired boolean
• IssuerCommonName string
• IssuerDistinguishedName string
• IssuerOrganization string
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
• NotAfter string
  Format date-time.
• NotBefore string
  Format date-time.
• Notes string
• Password sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• ReplacedBy string
• SelfSigned boolean
• SerialNumber string
• SignatureAlgorithmName string
• SpaceId string
• SubjectAlternativeNames array of string
• SubjectCommonName string
  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.
• SubjectDistinguishedName string
• SubjectOrganization string
  The certificate subject’s organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied.
• TenantIds array of string
• TenantTags array of string
• TenantedDeploymentParticipation enum
  Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.
• Thumbprint string
• Version integer

{
  "CertificateData": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "EnvironmentIds": [
    "string"
  ],
  "Name": "string",
  "Notes": "string",
  "Password": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "SpaceId": "string",
  "TenantIds": [
    "string"
  ],
  "TenantTags": [
    "string"
  ],
  "TenantedDeploymentParticipation": "Untenanted"
}

{
  "Archived": "2020-01-01T00:00:00.000Z",
  "CertificateChain": [
    {
      "IssuerDistinguishedName": "string",
      "NotAfter": "2020-01-01T00:00:00.000Z",
      "NotBefore": "2020-01-01T00:00:00.000Z",
      "SerialNumber": "string",
      "SignatureAlgorithmName": "string",
      "SubjectDistinguishedName": "string",
      "Thumbprint": "string",
      "Version": 0
    }
  ],
  "CertificateData": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "CertificateDataFormat": "Pkcs12",
  "EnvironmentIds": [
    "string"
  ],
  "HasPrivateKey": true,
  "Id": "string",
  "IsExpired": true,
  "IssuerCommonName": "string",
  "IssuerDistinguishedName": "string",
  "IssuerOrganization": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "NotAfter": "2020-01-01T00:00:00.000Z",
  "NotBefore": "2020-01-01T00:00:00.000Z",
  "Notes": "string",
  "Password": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "ReplacedBy": "string",
  "SelfSigned": true,
  "SerialNumber": "string",
  "SignatureAlgorithmName": "string",
  "SpaceId": "string",
  "SubjectAlternativeNames": [
    "string"
  ],
  "SubjectCommonName": "string",
  "SubjectDistinguishedName": "string",
  "SubjectOrganization": "string",
  "TenantIds": [
    "string"
  ],
  "TenantTags": [
    "string"
  ],
  "TenantedDeploymentParticipation": "Untenanted",
  "Thumbprint": "string",
  "Version": 0
}

GET /api/{spaceId}/certificates/all

Also reachable at /api/certificates/all, /api/spaces/{spaceIdentifier}/certificates/all.

Lists X.509 certificates managed by Octopus.

Path Parameters

• spaceId string (required)
  The ID of the space containing the resource(s).

Query Parameters

• ids array of string
  A set of Certificate IDs to retrieve Certificates for. Example: Certificate-101,Certificate-201.

Response

200 — The list of requested Certificates

• Archived string
  Format date-time.
• CertificateChain array of object
  • IssuerDistinguishedName string
  • NotAfter string
    Format date-time.
  • NotBefore string
    Format date-time.
  • SerialNumber string
  • SignatureAlgorithmName string
  • SubjectDistinguishedName string
  • Thumbprint string
  • Version integer
• CertificateData sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• CertificateDataFormat enum
  Allowed values: Pkcs12, Der, Pem, Unknown.
• EnvironmentIds array of string
• HasPrivateKey boolean
• Id string
  Gets or sets a unique identifier for this resource.
• IsExpired boolean
• IssuerCommonName string
• IssuerDistinguishedName string
• IssuerOrganization string
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
• NotAfter string
  Format date-time.
• NotBefore string
  Format date-time.
• Notes string
• Password sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• ReplacedBy string
• SelfSigned boolean
• SerialNumber string
• SignatureAlgorithmName string
• SpaceId string
• SubjectAlternativeNames array of string
• SubjectCommonName string
  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.
• SubjectDistinguishedName string
• SubjectOrganization string
  The certificate subject’s organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied.
• TenantIds array of string
• TenantTags array of string
• TenantedDeploymentParticipation enum
  Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.
• Thumbprint string
• Version integer

[
  {
    "Archived": "2020-01-01T00:00:00.000Z",
    "CertificateChain": [
      {
        "IssuerDistinguishedName": "string",
        "NotAfter": "2020-01-01T00:00:00.000Z",
        "NotBefore": "2020-01-01T00:00:00.000Z",
        "SerialNumber": "string",
        "SignatureAlgorithmName": "string",
        "SubjectDistinguishedName": "string",
        "Thumbprint": "string",
        "Version": 0
      }
    ],
    "CertificateData": {
      "HasValue": true,
      "Hint": "string",
      "NewValue": "string"
    },
    "CertificateDataFormat": "Pkcs12",
    "EnvironmentIds": [
      "string"
    ],
    "HasPrivateKey": true,
    "Id": "string",
    "IsExpired": true,
    "IssuerCommonName": "string",
    "IssuerDistinguishedName": "string",
    "IssuerOrganization": "string",
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "Name": "string",
    "NotAfter": "2020-01-01T00:00:00.000Z",
    "NotBefore": "2020-01-01T00:00:00.000Z",
    "Notes": "string",
    "Password": {
      "HasValue": true,
      "Hint": "string",
      "NewValue": "string"
    },
    "ReplacedBy": "string",
    "SelfSigned": true,
    "SerialNumber": "string",
    "SignatureAlgorithmName": "string",
    "SpaceId": "string",
    "SubjectAlternativeNames": [
      "string"
    ],
    "SubjectCommonName": "string",
    "SubjectDistinguishedName": "string",
    "SubjectOrganization": "string",
    "TenantIds": [
      "string"
    ],
    "TenantTags": [
      "string"
    ],
    "TenantedDeploymentParticipation": "Untenanted",
    "Thumbprint": "string",
    "Version": 0
  }
]

GET /api/certificates/certificate-global

Returns the server thumbprint used to identify this Octopus Server to any Tentacles when executing a deployment. Deprecated.

Response

200 — The requested global Certificate

• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
• SignatureAlgorithm string
• Thumbprint string

{
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "SignatureAlgorithm": "string",
  "Thumbprint": "string"
}

POST /api/{spaceId}/certificates/generate

Also reachable at /api/certificates/generate, /api/spaces/{spaceIdentifier}/certificates/generate.

Path Parameters

• spaceId string (required)

Request Body

• Archived string
  Format date-time.
• CertificateChain array of object
  • IssuerDistinguishedName string
  • NotAfter string
    Format date-time.
  • NotBefore string
    Format date-time.
  • SerialNumber string
  • SignatureAlgorithmName string
  • SubjectDistinguishedName string
  • Thumbprint string
  • Version integer
• CertificateData sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• CertificateDataFormat enum
  Allowed values: Pkcs12, Der, Pem, Unknown.
• EnvironmentIds array of string
• HasPrivateKey boolean
• Id string
  Gets or sets a unique identifier for this resource.
• IsExpired boolean
• IssuerCommonName string
• IssuerDistinguishedName string
• IssuerOrganization string
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
• NotAfter string
  Format date-time.
• NotBefore string
  Format date-time.
• Notes string
• Password sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• ReplacedBy string
• SelfSigned boolean
• SelfSignedCertificateCurve string
  Elliptic curve for the generated key pair: nistP256, nistP384 or nistP521. Defaults to nistP384 when omitted.
• SerialNumber string
• SignatureAlgorithmName string
• SpaceId string
• SubjectAlternativeNames array of string
• SubjectCommonName string
  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.
• SubjectDistinguishedName string
• SubjectOrganization string
  The certificate subject’s organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied.
• TenantIds array of string
• TenantTags array of string
• TenantedDeploymentParticipation enum
  Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.
• Thumbprint string
• Version integer

Response

200 — The newly-created self-signed Certificate.

• Archived string
  Format date-time.
• CertificateChain array of object
  • IssuerDistinguishedName string
  • NotAfter string
    Format date-time.
  • NotBefore string
    Format date-time.
  • SerialNumber string
  • SignatureAlgorithmName string
  • SubjectDistinguishedName string
  • Thumbprint string
  • Version integer
• CertificateData sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• CertificateDataFormat enum
  Allowed values: Pkcs12, Der, Pem, Unknown.
• EnvironmentIds array of string
• HasPrivateKey boolean
• Id string
  Gets or sets a unique identifier for this resource.
• IsExpired boolean
• IssuerCommonName string
• IssuerDistinguishedName string
• IssuerOrganization string
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
• NotAfter string
  Format date-time.
• NotBefore string
  Format date-time.
• Notes string
• Password sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• ReplacedBy string
• SelfSigned boolean
• SerialNumber string
• SignatureAlgorithmName string
• SpaceId string
• SubjectAlternativeNames array of string
• SubjectCommonName string
  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.
• SubjectDistinguishedName string
• SubjectOrganization string
  The certificate subject’s organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied.
• TenantIds array of string
• TenantTags array of string
• TenantedDeploymentParticipation enum
  Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.
• Thumbprint string
• Version integer

{
  "Archived": "2020-01-01T00:00:00.000Z",
  "CertificateChain": [
    {
      "IssuerDistinguishedName": "string",
      "NotAfter": "2020-01-01T00:00:00.000Z",
      "NotBefore": "2020-01-01T00:00:00.000Z",
      "SerialNumber": "string",
      "SignatureAlgorithmName": "string",
      "SubjectDistinguishedName": "string",
      "Thumbprint": "string",
      "Version": 0
    }
  ],
  "CertificateData": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "CertificateDataFormat": "Pkcs12",
  "EnvironmentIds": [
    "string"
  ],
  "HasPrivateKey": true,
  "Id": "string",
  "IsExpired": true,
  "IssuerCommonName": "string",
  "IssuerDistinguishedName": "string",
  "IssuerOrganization": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "NotAfter": "2020-01-01T00:00:00.000Z",
  "NotBefore": "2020-01-01T00:00:00.000Z",
  "Notes": "string",
  "Password": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "ReplacedBy": "string",
  "SelfSigned": true,
  "SelfSignedCertificateCurve": "string",
  "SerialNumber": "string",
  "SignatureAlgorithmName": "string",
  "SpaceId": "string",
  "SubjectAlternativeNames": [
    "string"
  ],
  "SubjectCommonName": "string",
  "SubjectDistinguishedName": "string",
  "SubjectOrganization": "string",
  "TenantIds": [
    "string"
  ],
  "TenantTags": [
    "string"
  ],
  "TenantedDeploymentParticipation": "Untenanted",
  "Thumbprint": "string",
  "Version": 0
}

{
  "Archived": "2020-01-01T00:00:00.000Z",
  "CertificateChain": [
    {
      "IssuerDistinguishedName": "string",
      "NotAfter": "2020-01-01T00:00:00.000Z",
      "NotBefore": "2020-01-01T00:00:00.000Z",
      "SerialNumber": "string",
      "SignatureAlgorithmName": "string",
      "SubjectDistinguishedName": "string",
      "Thumbprint": "string",
      "Version": 0
    }
  ],
  "CertificateData": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "CertificateDataFormat": "Pkcs12",
  "EnvironmentIds": [
    "string"
  ],
  "HasPrivateKey": true,
  "Id": "string",
  "IsExpired": true,
  "IssuerCommonName": "string",
  "IssuerDistinguishedName": "string",
  "IssuerOrganization": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "NotAfter": "2020-01-01T00:00:00.000Z",
  "NotBefore": "2020-01-01T00:00:00.000Z",
  "Notes": "string",
  "Password": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "ReplacedBy": "string",
  "SelfSigned": true,
  "SerialNumber": "string",
  "SignatureAlgorithmName": "string",
  "SpaceId": "string",
  "SubjectAlternativeNames": [
    "string"
  ],
  "SubjectCommonName": "string",
  "SubjectDistinguishedName": "string",
  "SubjectOrganization": "string",
  "TenantIds": [
    "string"
  ],
  "TenantTags": [
    "string"
  ],
  "TenantedDeploymentParticipation": "Untenanted",
  "Thumbprint": "string",
  "Version": 0
}

GET /api/{spaceId}/certificates/v2

Also reachable at /api/certificates/v2, /api/spaces/{spaceIdentifier}/certificates/v2.

Skip and Take are required. TotalResults is always the real count of matching certificates, including when Tenant or FirstResult is supplied. Certificate data and passwords are never returned by this endpoint.

Path Parameters

• spaceId string (required)
  The ID of the space containing the resource(s).

Query Parameters

• archived boolean
  When true, returns only archived certificates. Otherwise, returns only current (non-archived) certificates.
• firstResult string
  A certificate to return at the top of the first page even if it does not match the other filters, or is archived. Intended for a selector that has to show the currently selected certificate whatever else it lists.
• ids array of string
  Filters the certificates using the specified ids.
• orderBy string
  The order to return current certificates in: Expiry (the default, soonest to expire first) or Created (most recently added first). Ignored when Archived is true, since archived certificates are always returned most recently archived first. An unrecognised value is treated as Expiry.
• search string
  Filters the certificates using the specified fragment, matched against each certificate’s name, subject and thumbprint.
• skip integer (required)
  Number of items to skip. Defaults to zero. Minimum 0.
• take integer (required)
  Number of items to take. Defaults to 30. Minimum 0.
• tenant string
  Filters the certificates to those the specified Tenant can use, honouring both direct tenant links and tenant tags.

Response

200 — Success

• ItemType string
• Items array of object
  • Archived string
    Format date-time.
  • CertificateChain array of object
  • CertificateData sensitive value
  • CertificateDataFormat enum
    Allowed values: Pkcs12, Der, Pem, Unknown.
  • EnvironmentIds array of string
  • HasPrivateKey boolean
  • Id string
    Gets or sets a unique identifier for this resource.
  • IsExpired boolean
  • IssuerCommonName string
  • IssuerDistinguishedName string
  • IssuerOrganization string
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • Name string
  • NotAfter string
    Format date-time.
  • NotBefore string
    Format date-time.
  • Notes string
  • Password sensitive value
  • ReplacedBy string
  • SelfSigned boolean
  • SerialNumber string
  • SignatureAlgorithmName string
  • SpaceId string
  • SubjectAlternativeNames array of string
  • SubjectCommonName string
    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.
  • SubjectDistinguishedName string
  • SubjectOrganization string
    The certificate subject’s organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied.
  • TenantIds array of string
  • TenantTags array of string
  • TenantedDeploymentParticipation enum
    Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.
  • Thumbprint string
  • Version integer
• ItemsPerPage integer
• LastPageNumber integer
• NumberOfPages integer
• TotalResults integer

{
  "ItemType": "string",
  "Items": [
    {
      "Archived": "2020-01-01T00:00:00.000Z",
      "CertificateChain": [
        {}
      ],
      "CertificateData": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "CertificateDataFormat": "Pkcs12",
      "EnvironmentIds": [
        "string"
      ],
      "HasPrivateKey": true,
      "Id": "string",
      "IsExpired": true,
      "IssuerCommonName": "string",
      "IssuerDistinguishedName": "string",
      "IssuerOrganization": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "NotAfter": "2020-01-01T00:00:00.000Z",
      "NotBefore": "2020-01-01T00:00:00.000Z",
      "Notes": "string",
      "Password": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "ReplacedBy": "string",
      "SelfSigned": true,
      "SerialNumber": "string",
      "SignatureAlgorithmName": "string",
      "SpaceId": "string",
      "SubjectAlternativeNames": [
        "string"
      ],
      "SubjectCommonName": "string",
      "SubjectDistinguishedName": "string",
      "SubjectOrganization": "string",
      "TenantIds": [
        "string"
      ],
      "TenantTags": [
        "string"
      ],
      "TenantedDeploymentParticipation": "Untenanted",
      "Thumbprint": "string",
      "Version": 0
    }
  ],
  "ItemsPerPage": 0,
  "LastPageNumber": 0,
  "NumberOfPages": 0,
  "TotalResults": 0
}

GET /api/{spaceId}/certificates/{id}

Also reachable at /api/certificates/{id}, /api/spaces/{spaceIdentifier}/certificates/{id}.

Path Parameters

• id string (required)
  ID or Thumbprint of the Certificate.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — The requested Certificate

• Archived string
  Format date-time.
• CertificateChain array of object
  • IssuerDistinguishedName string
  • NotAfter string
    Format date-time.
  • NotBefore string
    Format date-time.
  • SerialNumber string
  • SignatureAlgorithmName string
  • SubjectDistinguishedName string
  • Thumbprint string
  • Version integer
• CertificateData sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• CertificateDataFormat enum
  Allowed values: Pkcs12, Der, Pem, Unknown.
• EnvironmentIds array of string
• HasPrivateKey boolean
• Id string
  Gets or sets a unique identifier for this resource.
• IsExpired boolean
• IssuerCommonName string
• IssuerDistinguishedName string
• IssuerOrganization string
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
• NotAfter string
  Format date-time.
• NotBefore string
  Format date-time.
• Notes string
• Password sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• ReplacedBy string
• SelfSigned boolean
• SerialNumber string
• SignatureAlgorithmName string
• SpaceId string
• SubjectAlternativeNames array of string
• SubjectCommonName string
  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.
• SubjectDistinguishedName string
• SubjectOrganization string
  The certificate subject’s organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied.
• TenantIds array of string
• TenantTags array of string
• TenantedDeploymentParticipation enum
  Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.
• Thumbprint string
• Version integer

{
  "Archived": "2020-01-01T00:00:00.000Z",
  "CertificateChain": [
    {
      "IssuerDistinguishedName": "string",
      "NotAfter": "2020-01-01T00:00:00.000Z",
      "NotBefore": "2020-01-01T00:00:00.000Z",
      "SerialNumber": "string",
      "SignatureAlgorithmName": "string",
      "SubjectDistinguishedName": "string",
      "Thumbprint": "string",
      "Version": 0
    }
  ],
  "CertificateData": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "CertificateDataFormat": "Pkcs12",
  "EnvironmentIds": [
    "string"
  ],
  "HasPrivateKey": true,
  "Id": "string",
  "IsExpired": true,
  "IssuerCommonName": "string",
  "IssuerDistinguishedName": "string",
  "IssuerOrganization": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "NotAfter": "2020-01-01T00:00:00.000Z",
  "NotBefore": "2020-01-01T00:00:00.000Z",
  "Notes": "string",
  "Password": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "ReplacedBy": "string",
  "SelfSigned": true,
  "SerialNumber": "string",
  "SignatureAlgorithmName": "string",
  "SpaceId": "string",
  "SubjectAlternativeNames": [
    "string"
  ],
  "SubjectCommonName": "string",
  "SubjectDistinguishedName": "string",
  "SubjectOrganization": "string",
  "TenantIds": [
    "string"
  ],
  "TenantTags": [
    "string"
  ],
  "TenantedDeploymentParticipation": "Untenanted",
  "Thumbprint": "string",
  "Version": 0
}

PUT /api/{spaceId}/certificates/{id}

Also reachable at /api/certificates/{id}, /api/spaces/{spaceIdentifier}/certificates/{id}.

Modifies an existing certificate

Path Parameters

• id string (required)
  The ID of the certificate.
• spaceId string (required)
  The ID of the space.

Request Body

• EnvironmentIds array of string
  The environments allowed to use this certificate.
• Id string (required)
  The ID of the certificate.
• Name string (required)
  The name of the certificate. Minimum length 1.
• Notes string
  Additional information on the certificate.
• SpaceId string (required)
  The ID of the space.
• TenantIds array of string
  The tenants this certificate should be associated with.
• TenantTags array of string
  The tags this certificate should be associated with.
• TenantedDeploymentParticipation enum
  The kind of deployments where this certificate should be included.
  Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.

Response

200 — The modified certificate resource

• Archived string
  Format date-time.
• CertificateChain array of object
  • IssuerDistinguishedName string
  • NotAfter string
    Format date-time.
  • NotBefore string
    Format date-time.
  • SerialNumber string
  • SignatureAlgorithmName string
  • SubjectDistinguishedName string
  • Thumbprint string
  • Version integer
• CertificateData sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• CertificateDataFormat enum
  Allowed values: Pkcs12, Der, Pem, Unknown.
• EnvironmentIds array of string
• HasPrivateKey boolean
• Id string
  Gets or sets a unique identifier for this resource.
• IsExpired boolean
• IssuerCommonName string
• IssuerDistinguishedName string
• IssuerOrganization string
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
• NotAfter string
  Format date-time.
• NotBefore string
  Format date-time.
• Notes string
• Password sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• ReplacedBy string
• SelfSigned boolean
• SerialNumber string
• SignatureAlgorithmName string
• SpaceId string
• SubjectAlternativeNames array of string
• SubjectCommonName string
  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.
• SubjectDistinguishedName string
• SubjectOrganization string
  The certificate subject’s organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied.
• TenantIds array of string
• TenantTags array of string
• TenantedDeploymentParticipation enum
  Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.
• Thumbprint string
• Version integer

{
  "EnvironmentIds": [
    "string"
  ],
  "Id": "string",
  "Name": "string",
  "Notes": "string",
  "SpaceId": "string",
  "TenantIds": [
    "string"
  ],
  "TenantTags": [
    "string"
  ],
  "TenantedDeploymentParticipation": "Untenanted"
}

{
  "Archived": "2020-01-01T00:00:00.000Z",
  "CertificateChain": [
    {
      "IssuerDistinguishedName": "string",
      "NotAfter": "2020-01-01T00:00:00.000Z",
      "NotBefore": "2020-01-01T00:00:00.000Z",
      "SerialNumber": "string",
      "SignatureAlgorithmName": "string",
      "SubjectDistinguishedName": "string",
      "Thumbprint": "string",
      "Version": 0
    }
  ],
  "CertificateData": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "CertificateDataFormat": "Pkcs12",
  "EnvironmentIds": [
    "string"
  ],
  "HasPrivateKey": true,
  "Id": "string",
  "IsExpired": true,
  "IssuerCommonName": "string",
  "IssuerDistinguishedName": "string",
  "IssuerOrganization": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "NotAfter": "2020-01-01T00:00:00.000Z",
  "NotBefore": "2020-01-01T00:00:00.000Z",
  "Notes": "string",
  "Password": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "ReplacedBy": "string",
  "SelfSigned": true,
  "SerialNumber": "string",
  "SignatureAlgorithmName": "string",
  "SpaceId": "string",
  "SubjectAlternativeNames": [
    "string"
  ],
  "SubjectCommonName": "string",
  "SubjectDistinguishedName": "string",
  "SubjectOrganization": "string",
  "TenantIds": [
    "string"
  ],
  "TenantTags": [
    "string"
  ],
  "TenantedDeploymentParticipation": "Untenanted",
  "Thumbprint": "string",
  "Version": 0
}

DELETE /api/{spaceId}/certificates/{id}

Also reachable at /api/certificates/{id}, /api/spaces/{spaceIdentifier}/certificates/{id}.

Path Parameters

• id string (required)
  ID of the Certificate to delete.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — Success

POST /api/{spaceId}/certificates/{id}/archive

Also reachable at /api/certificates/{id}/archive, /api/spaces/{spaceIdentifier}/certificates/{id}/archive.

Path Parameters

• id string (required)
  ID of the Certificate to archive.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — Success

POST /api/{spaceId}/certificates/{id}/archive/v1

Also reachable at /api/certificates/{id}/archive/v1, /api/spaces/{spaceIdentifier}/certificates/{id}/archive/v1.

Path Parameters

• id string (required)
  ID of the Certificate to archive.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — Confirmation that the Certificate has been archived

{}

GET /api/{spaceId}/certificates/{id}/export

Also reachable at /api/certificates/{id}/export, /api/spaces/{spaceIdentifier}/certificates/{id}/export.

Path Parameters

• id string (required)
  The ID of the certificate to export.
• spaceId string (required)
  ID of the space.

Query Parameters

• format enum
  The file format in which to export the certificate.
  Allowed values: Pkcs12, Der, Pem, Unknown.
• includePrivateKey boolean
  Whether the private key should be included in the exported file.
• password string
  The password to read the stored certificate.
• pemOptions enum
  Whether the exported PEM file should include the certificate chain.
  Allowed values: PrimaryOnly, PrimaryAndChain, ChainOnly.

Response

200 — Success

"string"

POST /api/{spaceId}/certificates/{id}/replace

Also reachable at /api/certificates/{id}/replace, /api/spaces/{spaceIdentifier}/certificates/{id}/replace.

Path Parameters

• id string (required)
  ID of the Certificate to Replace.
• spaceId string (required)
  The ID of the space containing the resource(s).

Request Body

• CertificateData string (required)
  Minimum length 1.
• Id string (required)
  ID of the Certificate to Replace.
• Password string
• SpaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — Confirmation that the Certificate has been replaced

• Archived string
  Format date-time.
• CertificateChain array of object
  • IssuerDistinguishedName string
  • NotAfter string
    Format date-time.
  • NotBefore string
    Format date-time.
  • SerialNumber string
  • SignatureAlgorithmName string
  • SubjectDistinguishedName string
  • Thumbprint string
  • Version integer
• CertificateData sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• CertificateDataFormat enum
  Allowed values: Pkcs12, Der, Pem, Unknown.
• EnvironmentIds array of string
• HasPrivateKey boolean
• Id string
  Gets or sets a unique identifier for this resource.
• IsExpired boolean
• IssuerCommonName string
• IssuerDistinguishedName string
• IssuerOrganization string
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
• NotAfter string
  Format date-time.
• NotBefore string
  Format date-time.
• Notes string
• Password sensitive value
  • HasValue boolean
  • Hint string
  • NewValue string
• ReplacedBy string
• SelfSigned boolean
• SerialNumber string
• SignatureAlgorithmName string
• SpaceId string
• SubjectAlternativeNames array of string
• SubjectCommonName string
  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.
• SubjectDistinguishedName string
• SubjectOrganization string
  The certificate subject’s organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied.
• TenantIds array of string
• TenantTags array of string
• TenantedDeploymentParticipation enum
  Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.
• Thumbprint string
• Version integer

{
  "CertificateData": "string",
  "Id": "string",
  "Password": "string",
  "SpaceId": "string"
}

{
  "Archived": "2020-01-01T00:00:00.000Z",
  "CertificateChain": [
    {
      "IssuerDistinguishedName": "string",
      "NotAfter": "2020-01-01T00:00:00.000Z",
      "NotBefore": "2020-01-01T00:00:00.000Z",
      "SerialNumber": "string",
      "SignatureAlgorithmName": "string",
      "SubjectDistinguishedName": "string",
      "Thumbprint": "string",
      "Version": 0
    }
  ],
  "CertificateData": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "CertificateDataFormat": "Pkcs12",
  "EnvironmentIds": [
    "string"
  ],
  "HasPrivateKey": true,
  "Id": "string",
  "IsExpired": true,
  "IssuerCommonName": "string",
  "IssuerDistinguishedName": "string",
  "IssuerOrganization": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "NotAfter": "2020-01-01T00:00:00.000Z",
  "NotBefore": "2020-01-01T00:00:00.000Z",
  "Notes": "string",
  "Password": {
    "HasValue": true,
    "Hint": "string",
    "NewValue": "string"
  },
  "ReplacedBy": "string",
  "SelfSigned": true,
  "SerialNumber": "string",
  "SignatureAlgorithmName": "string",
  "SpaceId": "string",
  "SubjectAlternativeNames": [
    "string"
  ],
  "SubjectCommonName": "string",
  "SubjectDistinguishedName": "string",
  "SubjectOrganization": "string",
  "TenantIds": [
    "string"
  ],
  "TenantTags": [
    "string"
  ],
  "TenantedDeploymentParticipation": "Untenanted",
  "Thumbprint": "string",
  "Version": 0
}

POST /api/{spaceId}/certificates/{id}/unarchive

Also reachable at /api/certificates/{id}/unarchive, /api/spaces/{spaceIdentifier}/certificates/{id}/unarchive.

Path Parameters

• id string (required)
  ID of the Certificate to unarchive.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — Success

POST /api/{spaceId}/certificates/{id}/unarchive/v1

Also reachable at /api/certificates/{id}/unarchive/v1, /api/spaces/{spaceIdentifier}/certificates/{id}/unarchive/v1.

Path Parameters

• id string (required)
  ID of the Certificate to unarchive.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — Confirmation that the Certificate has been un-archived

{}

GET /api/{spaceId}/certificates/{id}/usages

Also reachable at /api/certificates/{id}/usages, /api/spaces/{spaceIdentifier}/certificates/{id}/usages.

Get the usages of a certificate

Path Parameters

• id string (required)
  ID of the certificate.
• spaceId string (required)
  ID of the space.

Response

200 — The requested Certificate usages

• DeploymentTargetUsages array of object
  • Architecture string
  • Endpoint object
  • EnvironmentIds array of string
  • HasLatestCalamari boolean
  • HealthStatus enum
    Allowed values: Healthy, Unavailable, Unknown, HasWarnings, Unhealthy.
  • Id string
    Gets or sets a unique identifier for this resource.
  • IsDisabled boolean
  • IsInProcess boolean
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • MachinePolicyId string
  • Name string
  • OperatingSystem string
  • OperatingSystemVersion string
  • Roles array of string
  • ShellName string
  • ShellVersion string
  • SkipInitialHealthCheck boolean
  • Slug string
  • SpaceId string
  • StatusSummary string
  • TenantIds array of string
  • TenantTags array of string
  • TenantedDeploymentParticipation enum
    Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.
  • Thumbprint string
  • Uri string
• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LibraryVariableSetUsages array of object
  • ContentType enum
    Describes the purpose of the variable set. Clients can use this to offer an editing experience appropriately.
    Allowed values: Variables, ScriptModule.
  • Description string
    Gets or sets a description of this variable set that explains the purpose of the variable set to other users. This field may contain markdown.
  • Id string
    Gets or sets a unique identifier for this resource.
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • Name string
    Gets or sets the name of this variable set. This should be short, preferably 5-20 characters.
  • SpaceId string
  • Templates array of object
    Gets the variable templates.
  • VariableSetId string
    Gets or sets the id of the associated variable set.
  • Version integer
    Gets or sets the version number.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• ProjectUsages array of object
  • AllowIgnoreChannelRules boolean
  • AutoCreateRelease boolean
  • AutoDeployReleaseOverrides array of object
  • ClonedFromProjectId string
  • CombineHealthAndSyncStatusInDashboardLiveStatus boolean
  • DefaultGuidedFailureMode enum
    Allowed values: EnvironmentDefault, Off, On.
  • DefaultPowerShellEdition string
  • DefaultToSkipIfAlreadyInstalled boolean
  • DeploymentChangesTemplate string
  • DeploymentProcessId string
  • DeprovisioningRunbookId string
  • Description string
  • DiscreteChannelRelease boolean
    Treats releases of different channels to the same environment as a seperate deployment dimension. ‘False’ indicates a “hotfix”-style usage of channels (single release active per environment ignoring channels), whereas True indicates “microservice”-style usage (single release per environment per channel).
  • ExecuteDeploymentsOnEventBasedPipeline boolean
  • ExtensionSettings array of object
  • ForcePackageDownload boolean
  • Icon object
  • Id string
    Gets or sets a unique identifier for this resource.
  • IncludedLibraryVariableSetIds array of string
    Library variable sets included in the project. Sets are listed in order of precedence, with earlier items in the list overriding any variables with the same name and scope definition appearing later in the list.
  • IsBadgesEnabled boolean
  • IsDisabled boolean
  • IsVersionControlled boolean
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • LifecycleId string
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • Name string
  • PersistenceSettings object
  • ProjectConnectivityPolicy object
  • ProjectGroupId string
  • ProjectTags array of string
    List of tags assigned to this project.
  • ProjectTemplateDetails object
  • ProvisioningRunbookId string
  • ReleaseCreationStrategy object
  • ReleaseNotesTemplate string
  • Slug string
  • SpaceId string
  • Templates array of object
  • TenantedDeploymentMode enum
    Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.
  • VariableSetId string
  • VersioningStrategy object
• TenantUsages array of object
  • ClonedFromTenantId string
  • CustomFields array of string
  • Description string
  • Icon object
  • Id string
    Gets or sets a unique identifier for this resource.
  • IsDisabled boolean
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • Name string
  • ProjectEnvironments object
  • Slug string
  • SpaceId string
  • TenantTags array of string
    Tags are referenced by CanonicalName like {TagSetName}/{TagName}.

{
  "DeploymentTargetUsages": [
    {
      "Architecture": "string",
      "Endpoint": {
        "CommunicationStyle": "None",
        "Id": "string",
        "LastModifiedBy": "string",
        "LastModifiedOn": "2020-01-01T00:00:00.000Z",
        "Links": {}
      },
      "EnvironmentIds": [
        "string"
      ],
      "HasLatestCalamari": true,
      "HealthStatus": "Healthy",
      "Id": "string",
      "IsDisabled": true,
      "IsInProcess": true,
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "MachinePolicyId": "string",
      "Name": "string",
      "OperatingSystem": "string",
      "OperatingSystemVersion": "string",
      "Roles": [
        "string"
      ],
      "ShellName": "string",
      "ShellVersion": "string",
      "SkipInitialHealthCheck": true,
      "Slug": "string",
      "SpaceId": "string",
      "StatusSummary": "string",
      "TenantIds": [
        "string"
      ],
      "TenantTags": [
        "string"
      ],
      "TenantedDeploymentParticipation": "Untenanted",
      "Thumbprint": "string",
      "Uri": "string"
    }
  ],
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LibraryVariableSetUsages": [
    {
      "ContentType": "Variables",
      "Description": "string",
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "SpaceId": "string",
      "Templates": [
        {}
      ],
      "VariableSetId": "string",
      "Version": 0
    }
  ],
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "ProjectUsages": [
    {
      "AllowIgnoreChannelRules": true,
      "AutoCreateRelease": true,
      "AutoDeployReleaseOverrides": [
        {}
      ],
      "ClonedFromProjectId": "string",
      "CombineHealthAndSyncStatusInDashboardLiveStatus": true,
      "DefaultGuidedFailureMode": "EnvironmentDefault",
      "DefaultPowerShellEdition": "string",
      "DefaultToSkipIfAlreadyInstalled": true,
      "DeploymentChangesTemplate": "string",
      "DeploymentProcessId": "string",
      "DeprovisioningRunbookId": "string",
      "Description": "string",
      "DiscreteChannelRelease": true,
      "ExecuteDeploymentsOnEventBasedPipeline": true,
      "ExtensionSettings": [
        {}
      ],
      "ForcePackageDownload": true,
      "Icon": {
        "Color": "string",
        "Id": "string"
      },
      "Id": "string",
      "IncludedLibraryVariableSetIds": [
        "string"
      ],
      "IsBadgesEnabled": true,
      "IsDisabled": true,
      "IsVersionControlled": true,
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "LifecycleId": "string",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "PersistenceSettings": {
        "Type": "Database"
      },
      "ProjectConnectivityPolicy": {
        "AllowDeploymentsToNoTargets": true,
        "ExcludeUnhealthyTargets": true,
        "SkipMachineBehavior": "None",
        "TargetRoles": [
          "string"
        ]
      },
      "ProjectGroupId": "string",
      "ProjectTags": [
        "string"
      ],
      "ProjectTemplateDetails": {
        "IsShared": true,
        "Slug": "string",
        "VersionMask": "string"
      },
      "ProvisioningRunbookId": "string",
      "ReleaseCreationStrategy": {
        "ChannelId": "string",
        "ReleaseCreationPackage": {}
      },
      "ReleaseNotesTemplate": "string",
      "Slug": "string",
      "SpaceId": "string",
      "Templates": [
        {}
      ],
      "TenantedDeploymentMode": "Untenanted",
      "VariableSetId": "string",
      "VersioningStrategy": {
        "DonorPackage": {},
        "Template": "string"
      }
    }
  ],
  "TenantUsages": [
    {
      "ClonedFromTenantId": "string",
      "CustomFields": [
        "string"
      ],
      "Description": "string",
      "Icon": {
        "Color": "string",
        "Id": "string"
      },
      "Id": "string",
      "IsDisabled": true,
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "ProjectEnvironments": {
        "additionalProp1": [
          "string"
        ],
        "additionalProp2": [
          "string"
        ],
        "additionalProp3": [
          "string"
        ]
      },
      "Slug": "string",
      "SpaceId": "string",
      "TenantTags": [
        "string"
      ]
    }
  ]
}

GET /api/configuration/certificates

Only returns configurations for the global Certificate

Query Parameters

• skip integer
  Number of items to skip. Defaults to zero. Minimum 0.
• take integer
  Number of items to take. Defaults to 30. Minimum 0.

Response

200 — The requested Certificate Configurations

• Id string
  Gets or sets a unique identifier for this resource.
• ItemType string
• Items array of object
  • Id string
    Gets or sets a unique identifier for this resource.
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • Name string
  • SignatureAlgorithm string
  • Thumbprint string
• ItemsPerPage integer
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LastPageNumber integer
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• NumberOfPages integer
• TotalResults integer

{
  "Id": "string",
  "ItemType": "string",
  "Items": [
    {
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "SignatureAlgorithm": "string",
      "Thumbprint": "string"
    }
  ],
  "ItemsPerPage": 0,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LastPageNumber": 0,
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "NumberOfPages": 0,
  "TotalResults": 0
}

GET /api/configuration/certificates/{id}

Path Parameters

• id string (required)
  ID of the CertificateConfiguration to load.

Response

200 — The certificate configuration matching the supplied ID

• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
• SignatureAlgorithm string
• Thumbprint string

{
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "SignatureAlgorithm": "string",
  "Thumbprint": "string"
}

GET /api/configuration/certificates/{id}/public-cer

Downloads the public portion of the certificate in .cer format

Path Parameters

• id string (required)
  The Id of the certificate to retrieve the public portion of.

Response

200 — Success

"string"