CreateDomainAuthorization

POST

https://certificates.ezghcloud.com/v1/organizations/{orgId}/domain-authorizations

View as Markdown

Authorization

apiKeyoptionalHTTP
oauthoptionalHTTP
sessionCookieoptionalAPI key in cookie

Path parameters

orgIdstringrequired
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

domainNamestringrequired
nameoptionalstring
tagsoptionalmap ofstring

Returns

200

The organization already has an authorization for this domain; it is returned unchanged. Requires certificates.domainAuthorizations.get on it.

JSON

bindingGenerationintegerrequired
createdAtstringrequired
format: date-time
diagnosticsarray ofDomainCheckProblemorDomainCheckrequired
What the last DNS checks found, for this authorization's own names only. At most one problem entry (the last failed check: code, safe message, checkedAt; it has no name) comes first; the other entries are what the last successful check saw per name and perspective, kept when a later check fails. A successful check replaces the array with its checks.
2 variants
One of the following:
DomainCheckProblem
View DomainCheckProblem schema →
3 properties
checkedAtstringornullrequired
When the check ran

2 variants
One of the following:
string
null
codestringrequired
A check code: binding_missing, binding_conflict, binding_indirect, delegation_mismatch, challenge_not_visible, authority_changed, resolver_disagreement, dns_authority_unavailable, dns_lookup_failed, dns_query_budget_exhausted, caa_denied, caa_critical, domain_owned_elsewhere, dependency_unavailable, …; new codes may be added

messagestringrequired
A fixed, safe sentence for the code

DomainCheck
View DomainCheck schema →
6 properties
authorityFingerprintstringrequired
caaobjectornullrequired
The CAA lookup, or null when the check made none (a transfer's ownership proof)

2 variants
One of the following:
object
null
generationintegerrequired
The binding generation checked

namestringrequired
observedAtstringornullrequired
2 variants
One of the following:
string
null
perspectivestringrequired
The resolver or authoritative name server that answered
displayNamestringrequired
dnsInstructionsarray ofobjectrequired
3 properties
- namestringrequired
- typestringrequired
- valuestringrequired
domainNamestringrequired
enabledbooleanrequired
idstringrequired
format: uuid
namestringrequired
nextCheckAtstringornullrequired
When the next DNS check runs: after a failed check, when it is retried
2 variants
One of the following:
string
null
organizationIdstringrequired
format: uuid
projectIdnullrequired
regionstringrequired
resourceNamestringrequired
slugstringrequired
statusstringrequired
tagsmap ofstringrequired
updatedAtstringrequired
format: date-time
verifiedAtstringornullrequired
2 variants
One of the following:
string
null

201

Success

JSON

bindingGenerationintegerrequired
createdAtstringrequired
format: date-time
diagnosticsarray ofDomainCheckProblemorDomainCheckrequired
What the last DNS checks found, for this authorization's own names only. At most one problem entry (the last failed check: code, safe message, checkedAt; it has no name) comes first; the other entries are what the last successful check saw per name and perspective, kept when a later check fails. A successful check replaces the array with its checks.
2 variants
One of the following:
DomainCheckProblem
View DomainCheckProblem schema →
3 properties
checkedAtstringornullrequired
When the check ran

2 variants
One of the following:
string
null
codestringrequired
A check code: binding_missing, binding_conflict, binding_indirect, delegation_mismatch, challenge_not_visible, authority_changed, resolver_disagreement, dns_authority_unavailable, dns_lookup_failed, dns_query_budget_exhausted, caa_denied, caa_critical, domain_owned_elsewhere, dependency_unavailable, …; new codes may be added

messagestringrequired
A fixed, safe sentence for the code

DomainCheck
View DomainCheck schema →
6 properties
authorityFingerprintstringrequired
caaobjectornullrequired
The CAA lookup, or null when the check made none (a transfer's ownership proof)

2 variants
One of the following:
object
null
generationintegerrequired
The binding generation checked

namestringrequired
observedAtstringornullrequired
2 variants
One of the following:
string
null
perspectivestringrequired
The resolver or authoritative name server that answered
displayNamestringrequired
dnsInstructionsarray ofobjectrequired
3 properties
- namestringrequired
- typestringrequired
- valuestringrequired
domainNamestringrequired
enabledbooleanrequired
idstringrequired
format: uuid
namestringrequired
nextCheckAtstringornullrequired
When the next DNS check runs: after a failed check, when it is retried
2 variants
One of the following:
string
null
organizationIdstringrequired
format: uuid
projectIdnullrequired
regionstringrequired
resourceNamestringrequired
slugstringrequired
statusstringrequired
tagsmap ofstringrequired
updatedAtstringrequired
format: date-time
verifiedAtstringornullrequired
2 variants
One of the following:
string
null

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.