Get certificate

GET 
/certificates/certificate

Return details for a specific certificate

Scopes

• certificates
• certificates:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

certificate[id] string

All 'certificate[]' params are mutually exclusive, only one can be provided.

Responses

200

Return details for a specific certificate

application/json

Schema

Schema

certificate

object[]

required

Array [

id string

name string

additional_names string[]

issuer IssuerEnum (string)

Possible values: [lets_encrypt, custom, self_signed]

state CertificateStateEnum (string)

Possible values: [pending, issue_failed, issued, issuing]

created_at integer

expires_at integernullable

last_issued_at integernullable

issue_error stringnullable

authorization_method stringnullable

certificate_api_url stringnullable

This is the URL that can be used to access this certificate's details. through the certificate API (a different API to this one). If null, this means that it is no longer available. If that is the case, you can get a new URL by resetting the API token for this certificate.

certificate stringnullable

chain stringnullable

private_key stringnullable

]

Example (from schema)

{
  "certificate": [
    {
      "id": "string",
      "name": "string",
      "additional_names": [
        "string"
      ],
      "issuer": "lets_encrypt",
      "state": "pending",
      "created_at": 0,
      "expires_at": 0,
      "last_issued_at": 0,
      "issue_error": "string",
      "authorization_method": "string",
      "certificate_api_url": "string",
      "certificate": "string",
      "chain": "string",
      "private_key": "string"
    }
  ]
}

400

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

application/json

Schema

Schema

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string
detail object

Example (from schema)

{
  "code": "missing_api_token",
  "description": "string",
  "detail": {}
}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

Example (from schema)

{}

404

No certificate was found matching any of the criteria provided in the arguments

application/json

Schema

Schema

code CertificateNotFoundEnum (string)

Possible values: [certificate_not_found]

description string
detail object

Example (from schema)

{
  "code": "certificate_not_found",
  "description": "string",
  "detail": {}
}

406

The object found is in the trash and therefore cannot be manipulated through the API. It should be restored in order to run this operation.

application/json

Schema

Schema

code ObjectInTrashEnum (string)

Possible values: [object_in_trash]

description string

detail

object

trash_object

object

nullable

id string

keep_until integer

object_id string

object_type string

Example (from schema)

{
  "code": "object_in_trash",
  "description": "string",
  "detail": {
    "trash_object": {
      "id": "string",
      "keep_until": 0,
      "object_id": "string",
      "object_type": "string"
    }
  }
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...