Process a Tls Certificate

POST 
/api/v8/partner/settings/tls-certificate

Create a Tls Certificate

Request

Responses

201

A Tls Certificate.

application/json

Schema

Schema

id integerrequired

Possible values: > 0

certificate_id stringrequired

Possible values: non-empty

issued_on date-timerequired
expires_on date-timerequired
certificate_body stringrequired

Possible values: non-empty

key_body stringrequired

Possible values: non-empty

Example (from schema)

{
  "id": 0,
  "certificate_id": "string",
  "issued_on": "2025-10-09T16:35:19.389Z",
  "expires_on": "2025-10-09T16:35:19.389Z",
  "certificate_body": "string",
  "key_body": "string"
}

400

User error

application/json

Schema

Schema

oneOf

MAXIMUM_NUMBER_OF_ACTIVE_CERTIFICATES_REACHED

status string

Default value: fail

error string

Default value: Maximum number of active certificates reached

FAILED_TO_CREATE_CERTIFICATE

status string

Default value: fail

error string

Default value: Failed to create certificate

Example (from schema)

{}

403

User error

application/json

Schema

Schema

oneOf

MTLS_IS_NOT_ENABLED_FOR_YOUR_CLIENT

status string

Default value: fail

error string

Default value: mTLS is not enabled for your client

Example (from schema)

{}

404

Not found

application/json

Schema

Schema

oneOf

NOT_FOUND

status string

Default value: fail

error string

Default value: Not found.

DOCUMENT_NOT_FOUND

status string

Default value: fail

error string

Default value: Document Not Found

Example (from schema)

{}

413

Request body too large

application/json

Schema

Schema

oneOf

REQUEST_BODY_TOO_LARGE

status string

Default value: fail

error string

Default value: Request body too large

Example (from schema)

{}

429

Rate limit

application/json

Schema

Schema

oneOf

YOU_HAVE_BEEN_RATE_LIMITED

status string

Default value: fail

error string

Default value: You have been rate limited

details undefined[]

Default value: [object Object]

Example (from schema)

{}

499

User error

application/json

Schema

Schema

oneOf

CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION

status string

Default value: fail

error string

Default value: Client closed request or lost connection

Example (from schema)

{}

500

Unexpected error

503

Service is temporarily unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORARILY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

Default value: Service is temporarily unavailable. Please try again later

Example (from schema)

{}

504

Gateway timeout. Returned if request takes more than 100 seconds. The request might finish successfully later.

application/json

Schema

Schema

oneOf

GATEWAY_TIMEOUT

status string

Default value: fail

error string

Default value: Gateway timeout

Example (from schema)

{}

default

General error response

application/json

Schema

Schema

status string

Default value: fail

error stringrequired
details object[]

Example (from schema)

{
  "status": "fail",
  "error": "string"
}

Loading...