Skip to content

Create a root certificate authority

POST
/api/cas
curl --request POST \
--url https://gateway.example.com/api/cas \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "commonName": "example", "keyAlgorithm": "rsa-2048", "validityYears": 1, "pathLengthConstraint": 1, "maxValidityDays": 365, "folderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'
Idempotency-Key
string
>= 1 characters <= 255 characters

Optional retry key (1-255 printable ASCII characters), bound to your token or session and its current scopes. A retry with the same key and request within 24 hours replays the original response with Idempotency-Replayed: true; a different request under the same key returns 422 IDEMPOTENCY_KEY_REUSED, a retry while the first request still runs returns 409 IDEMPOTENCY_KEY_IN_PROGRESS with Retry-After, and a completed request whose response was not stored returns 409 IDEMPOTENCY_RESPONSE_WITHHELD.

JSON request body

Media typeapplication/json
object
commonName
required
string
>= 1 characters <= 255 characters
keyAlgorithm
required
string
Allowed values: rsa-2048 rsa-4096 ecdsa-p256 ecdsa-p384
validityYears
required
integer
>= 1 <= 30
pathLengthConstraint
integer
maxValidityDays
integer
default: 365 >= 1 <= 3650
folderId
string | null format: uuid

Created

Media typeapplication/json
object
data
required

Resource object. Exact fields depend on the endpoint.

object
id
string
name
string
key
additional properties
Example
{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"commonName": "Example Root CA",
"type": "root",
"status": "active",
"notAfter": "2034-01-01T00:00:00.000Z"
}
}

Bad request

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"path": [
"name"
],
"message": "Required"
}
]
}

Authentication required

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "UNAUTHORIZED",
"message": "Authentication required"
}

Forbidden

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "FORBIDDEN",
"message": "Insufficient permissions"
}

Not found

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "NOT_FOUND",
"message": "Resource not found"
}

Conflict

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "CONFLICT",
"message": "Resource already exists"
}

Unprocessable entity

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "UNPROCESSABLE_ENTITY",
"message": "Request could not be processed"
}

Internal server error

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "INTERNAL_ERROR",
"message": "Internal server error"
}