CreateCertificateAuthority

POST

https://certificates.ezghcloud.com/v1/organizations/{orgId}/projects/{projectId}/certificate-authorities

View as Markdown

Authorization

apiKeyoptionalHTTP
oauthoptionalHTTP
sessionCookieoptionalAPI key in cookie

Path parameters

orgIdstringrequired
format: uuid
projectIdstringrequired
format: uuid

Header parameters

Idempotency-Keyoptionalstring
Makes a retry safe: the same key and request get the stored response.

pattern: ^[\x21-\x7e]{1,200}$

Request bodyJSONrequired

keyAlgorithmecdsa-p256orecdsa-p384orrsa-2048orrsa-3072orrsa-4096required
namestringrequired
maxLength: 100, minLength: 1
subjectobjectrequired
6 properties
- commonNamestringrequired
  maxLength: 64, minLength: 1
- countryoptionalarray ofstring
- localityoptionalarray ofstring
- organizationoptionalarray ofstring
- organizationalUnitoptionalarray ofstring
- provinceoptionalarray ofstring
typerootorsubordinaterequired
descriptionoptionalstring
maxLength: 1000
maxLeafValidityDaysoptionalinteger
Subordinates only, default 90; may later only shrink

maximum: 825, minimum: 1
nameConstraintsoptionalobject
Fixed at creation. DNS and URI entries: a host or .domain; email: a mailbox, host or .domain; IP: a masked CIDR prefix. A hosted subordinate's are within its parent's.
8 properties
- excludedDnsoptionalarray ofstring
- excludedEmailoptionalarray ofstring
- excludedIpoptionalarray ofstring
- excludedUrioptionalarray ofstring
- permittedDnsoptionalarray ofstring
- permittedEmailoptionalarray ofstring
- permittedIpoptionalarray ofstring
- permittedUrioptionalarray ofstring
parentIdoptionalstring
A hosted subordinate's parent CA, in the same project (needs certificates.certificateAuthorities.issue on it)

format: uuid
parentKindoptionalhostedorexternal
Subordinates only: hosted (the default) or external (signed by your own root, then imported)
pathLengthoptionalinteger
Roots -1 (unlimited) to 2, default 1; subordinates 0 to 2 and below the parent's, default 0

maximum: 2, minimum: -1
tagsoptionalmap ofstring
validityDaysoptionalinteger
Roots 365-9132, default 3650; subordinates 365-3653, default 1825 (never past the parent's notAfter)

maximum: 9132, minimum: 365

Returns

202

Accepted: the operation finishes it

JSON

operationobjectrequired
14 properties
- actionstringrequired
- cancellablebooleanrequired
- createdAtstringrequired
  format: date-time
- createdByobjectrequired
- errorobjectornullrequired
  2 variants
  One of the following:
  object
  null
- finishedAtstringornullrequired
  2 variants
  One of the following:
  string
  null
- idstringrequired
  format: uuid
- organizationIdstringrequired
  format: uuid
- projectIdstringornullrequired
  2 variants
  One of the following:
  string
  null
- startedAtstringornullrequired
  2 variants
  One of the following:
  string
  null
- statusstringrequired
- targetobjectrequired
  3 properties
  idstringrequired
  format: uuid
  resourceNamestringrequired
  typestringrequired
- typestringrequired
- updatedAtstringrequired
  format: date-time
resourceobjectrequired
34 properties
- acmeDirectoryUrlstringornullrequired
  2 variants
  One of the following:
  string
  null
- caIssuerUrlstringrequired
- certificatePemstringornullrequired
  2 variants
  One of the following:
  string
  null
- chainPemarray ofstringrequired
- createdAtstringrequired
  format: date-time
- crlThisUpdatestringornullrequired
  thisUpdate of the CA's newest CRL; null before the first
  
  2 variants
  One of the following:
  string
  null
- crlUrlstringrequired
- csrPemstringornullrequired
  2 variants
  One of the following:
  string
  null
- deletionAtstringornullrequired
  2 variants
  One of the following:
  string
  null
- descriptionstringrequired
- idstringrequired
  format: uuid
- keyAlgorithmstringrequired
- maxLeafValidityDaysintegerornullrequired
  2 variants
  One of the following:
  integer
  null
- namestringrequired
- nameConstraintsobjectrequired
  8 properties
  excludedDnsarray ofstringrequired
  excludedEmailarray ofstringrequired
  excludedIparray ofstringrequired
  excludedUriarray ofstringrequired
  permittedDnsarray ofstringrequired
  permittedEmailarray ofstringrequired
  permittedIparray ofstringrequired
  permittedUriarray ofstringrequired
- notAfterstringornullrequired
  2 variants
  One of the following:
  string
  null
- notBeforestringornullrequired
  2 variants
  One of the following:
  string
  null
- ocspUrlstringrequired
- organizationIdstringrequired
  format: uuid
- parentIdstringornullrequired
  2 variants
  One of the following:
  string
  null
- parentKindstringornullrequired
  2 variants
  One of the following:
  string
  null
- pathLengthintegerrequired
- projectIdstringrequired
  format: uuid
- regionstringrequired
- resourceNamestringrequired
- revocationReasonstringornullrequired
  2 variants
  One of the following:
  string
  null
- revokedAtstringornullrequired
  When a subordinate was revoked through its parent (it then stays disabled); null otherwise
  
  2 variants
  One of the following:
  string
  null
- slugstringrequired
- statestringrequired
- subjectobjectrequired
  6 properties
  commonNamestringrequired
  countryarray ofstringrequired
  localityarray ofstringrequired
  organizationarray ofstringrequired
  organizationalUnitarray ofstringrequired
  provincearray ofstringrequired
- tagsmap ofstringrequired
- typerootorsubordinaterequired
- updatedAtstringrequired
  format: date-time
- validityDaysintegerrequired

400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

401

unauthenticated: no credential, or one that doesn't check out.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

404

not_found: unknown, malformed, or in an organization the caller isn't in.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

409

quota_exceeded (an allocation quota, with quota), idempotency_conflict, idempotency_in_progress (with Retry-After), organization_deletion_pending, operation_in_progress, or the endpoint's own 409 codes.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

413

payload_too_large: the body is over the endpoint's limit (1 MiB unless it says otherwise).

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

503

unavailable: a dependency the request needs is down. Retry after Retry-After.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.