Перейти к основному содержимому
API docs by Redocly

User Certificates API (v1.0)

Managing user TLS certificates

Certificates

Delete certificate with specified ID

Authorizations:
X-Auth-Token
path Parameters
cert_id
required
string

Certificate's ID

query Parameters
force
boolean

Remove certificate even when consumers is not empty

Responses

Get certificate with specified ID

Authorizations:
X-Auth-Token
path Parameters
cert_id
required
string

Certificate's ID

Responses

UpdateVersion certificate version for specified ID

Authorizations:
X-Auth-Token
path Parameters
cert_id
required
string

Certificate's ID

Request Body schema: application/json
required

Payload

object

Certificate in PEM encoded format

certificates
Array of strings

List of PEM encoded cerficates

private_key
string

Private key in PEM encoded format

Responses

Request samples

Content type
application/json
{
  • "pem": {
    }
}

Update certificate name for specified ID

Authorizations:
X-Auth-Token
path Parameters
cert_id
required
string

Certificate's ID

Request Body schema: application/json
required

Payload

name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Get a public certs for certificate

Authorizations:
X-Auth-Token
path Parameters
cert_id
required
string

Certificate's ID

Responses

Remove consumer from certificate

Authorizations:
X-Auth-Token
path Parameters
cert_id
required
string

Certificate's ID

Request Body schema: application/json
required

Payload

Array of objects (rest.Consumer)
id
string
region
string
type
string

Responses

Request samples

Content type
application/json
{
  • "consumers": [
    ],
  • "id": "string",
  • "region": "string",
  • "type": "string"
}

Add new consumer to certificate

Authorizations:
X-Auth-Token
path Parameters
cert_id
required
string

Certificate's ID

Request Body schema: application/json
required

Payload

Array of objects (rest.Consumer)
id
string
region
string
type
string

Responses

Request samples

Content type
application/json
{
  • "consumers": [
    ],
  • "id": "string",
  • "region": "string",
  • "type": "string"
}

Get a everything related to this certificate in PKCS#12 bundle

Authorizations:
X-Auth-Token
path Parameters
cert_id
required
string

Certificate's ID

Responses

Get a private key for certificate

Authorizations:
X-Auth-Token
path Parameters
cert_id
required
string

Certificate's ID

Responses

List will return certificates

Authorizations:
X-Auth-Token

Responses

Upload will upload new certificate in storage

Authorizations:
X-Auth-Token
Request Body schema: application/json
required

Payload

name
string
object

Certificate in PEM encoded format

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "pem": {
    }
}