--- title: "GetDomainAuthorization" --- > Documentation Index > Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt > Use this file to discover all available pages before exploring further. Path: Web Certificates API `GET /v1/organizations/{orgId}/domain-authorizations/{authorizationId}` ## Authentication Requires one of the following: - `apiKey`, http, header `Authorization` - `oauth`, http, header `Authorization` - `sessionCookie`, apiKey, in cookie ## Path parameters - `GetDomainAuthorization.path.orgId` (string, required) - format `uuid` - `GetDomainAuthorization.path.authorizationId` (string, required) - format `uuid` ## Code samples ### cURL ```curl curl --request GET \ --url https://certificates.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/domain-authorizations/497f6eca-6276-4993-bfeb-53cbbbba6f08 \ --header 'Authorization: Bearer ' ``` ### TypeScript ```typescript const url = 'https://certificates.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/domain-authorizations/497f6eca-6276-4993-bfeb-53cbbbba6f08'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err)); ``` ### Python ```python import requests url = "https://certificates.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/domain-authorizations/497f6eca-6276-4993-bfeb-53cbbbba6f08" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.text) ``` ## Responses ### 200 Success #### Example ```json { "bindingGeneration": 0, "createdAt": "2019-08-24T14:15:22Z", "diagnostics": [ { "checkedAt": "2019-08-24T14:15:22Z", "code": "string", "message": "string" } ], "displayName": "string", "dnsInstructions": [ { "name": "string", "type": "string", "value": "string" } ], "domainName": "string", "enabled": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "nextCheckAt": "2019-08-24T14:15:22Z", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "projectId": null, "region": "", "resourceName": "string", "slug": "string", "status": "string", "tags": { "property1": "string", "property2": "string" }, "updatedAt": "2019-08-24T14:15:22Z", "verifiedAt": "2019-08-24T14:15:22Z" } ``` - `GetDomainAuthorization.response.200.bindingGeneration` (integer, required) - `GetDomainAuthorization.response.200.createdAt` (string, required) - format `date-time` - `GetDomainAuthorization.response.200.diagnostics` (array, required) — 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. - one of: [DomainCheckProblem](/certificates-api/schemas/DomainCheckProblem/), [DomainCheck](/certificates-api/schemas/DomainCheck/) - `GetDomainAuthorization.response.200.displayName` (string, required) - `GetDomainAuthorization.response.200.dnsInstructions` (array, required) - `GetDomainAuthorization.response.200.dnsInstructions.name` (string, required) - `GetDomainAuthorization.response.200.dnsInstructions.type` (string, required) - `GetDomainAuthorization.response.200.dnsInstructions.value` (string, required) - `GetDomainAuthorization.response.200.domainName` (string, required) - `GetDomainAuthorization.response.200.enabled` (boolean, required) - `GetDomainAuthorization.response.200.id` (string, required) - format `uuid` - `GetDomainAuthorization.response.200.name` (string, required) - `GetDomainAuthorization.response.200.nextCheckAt` (any of, required) — When the next DNS check runs: after a failed check, when it is retried - any of: `string`, `null` - `GetDomainAuthorization.response.200.organizationId` (string, required) - format `uuid` - `GetDomainAuthorization.response.200.projectId` (null, required) - `GetDomainAuthorization.response.200.region` (string, required) - `GetDomainAuthorization.response.200.resourceName` (string, required) - `GetDomainAuthorization.response.200.slug` (string, required) - `GetDomainAuthorization.response.200.status` (string, required) - `GetDomainAuthorization.response.200.tags` (map, required) - `GetDomainAuthorization.response.200.updatedAt` (string, required) - format `date-time` - `GetDomainAuthorization.response.200.verifiedAt` (any of, required) - any of: `string`, `null` ### 400 invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `GetDomainAuthorization.response.400.error` (object, required) - `GetDomainAuthorization.response.400.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDomainAuthorization.response.400.error.message` (string, required) - maxLength 1024 - `GetDomainAuthorization.response.400.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDomainAuthorization.response.400.error.issues.message` (string, required) - `GetDomainAuthorization.response.400.error.issues.path` (string, required) - `GetDomainAuthorization.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDomainAuthorization.response.400.error.quota.id` (string, required) - `GetDomainAuthorization.response.400.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDomainAuthorization.response.400.error.quota.limit` (integer, required) - min 0 - `GetDomainAuthorization.response.400.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDomainAuthorization.response.400.error.quota.inFlight` (integer, optional) - min 0 - `GetDomainAuthorization.response.400.error.quota.periodStart` (string, optional) - format `date-time` - `GetDomainAuthorization.response.400.error.quota.region` (string, optional) - `GetDomainAuthorization.response.400.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDomainAuthorization.response.400.error.quota.scopeResourceName` (string, optional) - `GetDomainAuthorization.response.400.error.quota.used` (integer, optional) - min 0 - `GetDomainAuthorization.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 401 unauthenticated: no credential, or one that doesn't check out. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `GetDomainAuthorization.response.401.error` (object, required) - `GetDomainAuthorization.response.401.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDomainAuthorization.response.401.error.message` (string, required) - maxLength 1024 - `GetDomainAuthorization.response.401.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDomainAuthorization.response.401.error.issues.message` (string, required) - `GetDomainAuthorization.response.401.error.issues.path` (string, required) - `GetDomainAuthorization.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDomainAuthorization.response.401.error.quota.id` (string, required) - `GetDomainAuthorization.response.401.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDomainAuthorization.response.401.error.quota.limit` (integer, required) - min 0 - `GetDomainAuthorization.response.401.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDomainAuthorization.response.401.error.quota.inFlight` (integer, optional) - min 0 - `GetDomainAuthorization.response.401.error.quota.periodStart` (string, optional) - format `date-time` - `GetDomainAuthorization.response.401.error.quota.region` (string, optional) - `GetDomainAuthorization.response.401.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDomainAuthorization.response.401.error.quota.scopeResourceName` (string, optional) - `GetDomainAuthorization.response.401.error.quota.used` (integer, optional) - min 0 - `GetDomainAuthorization.response.401.error.quota.window` (string, optional) — 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. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `GetDomainAuthorization.response.403.error` (object, required) - `GetDomainAuthorization.response.403.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDomainAuthorization.response.403.error.message` (string, required) - maxLength 1024 - `GetDomainAuthorization.response.403.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDomainAuthorization.response.403.error.issues.message` (string, required) - `GetDomainAuthorization.response.403.error.issues.path` (string, required) - `GetDomainAuthorization.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDomainAuthorization.response.403.error.quota.id` (string, required) - `GetDomainAuthorization.response.403.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDomainAuthorization.response.403.error.quota.limit` (integer, required) - min 0 - `GetDomainAuthorization.response.403.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDomainAuthorization.response.403.error.quota.inFlight` (integer, optional) - min 0 - `GetDomainAuthorization.response.403.error.quota.periodStart` (string, optional) - format `date-time` - `GetDomainAuthorization.response.403.error.quota.region` (string, optional) - `GetDomainAuthorization.response.403.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDomainAuthorization.response.403.error.quota.scopeResourceName` (string, optional) - `GetDomainAuthorization.response.403.error.quota.used` (integer, optional) - min 0 - `GetDomainAuthorization.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 404 not_found: unknown, malformed, or in an organization the caller isn't in. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `GetDomainAuthorization.response.404.error` (object, required) - `GetDomainAuthorization.response.404.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDomainAuthorization.response.404.error.message` (string, required) - maxLength 1024 - `GetDomainAuthorization.response.404.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDomainAuthorization.response.404.error.issues.message` (string, required) - `GetDomainAuthorization.response.404.error.issues.path` (string, required) - `GetDomainAuthorization.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDomainAuthorization.response.404.error.quota.id` (string, required) - `GetDomainAuthorization.response.404.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDomainAuthorization.response.404.error.quota.limit` (integer, required) - min 0 - `GetDomainAuthorization.response.404.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDomainAuthorization.response.404.error.quota.inFlight` (integer, optional) - min 0 - `GetDomainAuthorization.response.404.error.quota.periodStart` (string, optional) - format `date-time` - `GetDomainAuthorization.response.404.error.quota.region` (string, optional) - `GetDomainAuthorization.response.404.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDomainAuthorization.response.404.error.quota.scopeResourceName` (string, optional) - `GetDomainAuthorization.response.404.error.quota.used` (integer, optional) - min 0 - `GetDomainAuthorization.response.404.error.quota.window` (string, optional) — 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. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `GetDomainAuthorization.response.409.error` (object, required) - `GetDomainAuthorization.response.409.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDomainAuthorization.response.409.error.message` (string, required) - maxLength 1024 - `GetDomainAuthorization.response.409.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDomainAuthorization.response.409.error.issues.message` (string, required) - `GetDomainAuthorization.response.409.error.issues.path` (string, required) - `GetDomainAuthorization.response.409.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDomainAuthorization.response.409.error.quota.id` (string, required) - `GetDomainAuthorization.response.409.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDomainAuthorization.response.409.error.quota.limit` (integer, required) - min 0 - `GetDomainAuthorization.response.409.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDomainAuthorization.response.409.error.quota.inFlight` (integer, optional) - min 0 - `GetDomainAuthorization.response.409.error.quota.periodStart` (string, optional) - format `date-time` - `GetDomainAuthorization.response.409.error.quota.region` (string, optional) - `GetDomainAuthorization.response.409.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDomainAuthorization.response.409.error.quota.scopeResourceName` (string, optional) - `GetDomainAuthorization.response.409.error.quota.used` (integer, optional) - min 0 - `GetDomainAuthorization.response.409.error.quota.window` (string, optional) — 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. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `GetDomainAuthorization.response.429.error` (object, required) - `GetDomainAuthorization.response.429.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDomainAuthorization.response.429.error.message` (string, required) - maxLength 1024 - `GetDomainAuthorization.response.429.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDomainAuthorization.response.429.error.issues.message` (string, required) - `GetDomainAuthorization.response.429.error.issues.path` (string, required) - `GetDomainAuthorization.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDomainAuthorization.response.429.error.quota.id` (string, required) - `GetDomainAuthorization.response.429.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDomainAuthorization.response.429.error.quota.limit` (integer, required) - min 0 - `GetDomainAuthorization.response.429.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDomainAuthorization.response.429.error.quota.inFlight` (integer, optional) - min 0 - `GetDomainAuthorization.response.429.error.quota.periodStart` (string, optional) - format `date-time` - `GetDomainAuthorization.response.429.error.quota.region` (string, optional) - `GetDomainAuthorization.response.429.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDomainAuthorization.response.429.error.quota.scopeResourceName` (string, optional) - `GetDomainAuthorization.response.429.error.quota.used` (integer, optional) - min 0 - `GetDomainAuthorization.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 500 internal_error: a bug; the details are in the logs, under the request ID. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `GetDomainAuthorization.response.500.error` (object, required) - `GetDomainAuthorization.response.500.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDomainAuthorization.response.500.error.message` (string, required) - maxLength 1024 - `GetDomainAuthorization.response.500.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDomainAuthorization.response.500.error.issues.message` (string, required) - `GetDomainAuthorization.response.500.error.issues.path` (string, required) - `GetDomainAuthorization.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDomainAuthorization.response.500.error.quota.id` (string, required) - `GetDomainAuthorization.response.500.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDomainAuthorization.response.500.error.quota.limit` (integer, required) - min 0 - `GetDomainAuthorization.response.500.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDomainAuthorization.response.500.error.quota.inFlight` (integer, optional) - min 0 - `GetDomainAuthorization.response.500.error.quota.periodStart` (string, optional) - format `date-time` - `GetDomainAuthorization.response.500.error.quota.region` (string, optional) - `GetDomainAuthorization.response.500.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDomainAuthorization.response.500.error.quota.scopeResourceName` (string, optional) - `GetDomainAuthorization.response.500.error.quota.used` (integer, optional) - min 0 - `GetDomainAuthorization.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 503 unavailable: a dependency the request needs is down. Retry after Retry-After. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `GetDomainAuthorization.response.503.error` (object, required) - `GetDomainAuthorization.response.503.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDomainAuthorization.response.503.error.message` (string, required) - maxLength 1024 - `GetDomainAuthorization.response.503.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDomainAuthorization.response.503.error.issues.message` (string, required) - `GetDomainAuthorization.response.503.error.issues.path` (string, required) - `GetDomainAuthorization.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDomainAuthorization.response.503.error.quota.id` (string, required) - `GetDomainAuthorization.response.503.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDomainAuthorization.response.503.error.quota.limit` (integer, required) - min 0 - `GetDomainAuthorization.response.503.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDomainAuthorization.response.503.error.quota.inFlight` (integer, optional) - min 0 - `GetDomainAuthorization.response.503.error.quota.periodStart` (string, optional) - format `date-time` - `GetDomainAuthorization.response.503.error.quota.region` (string, optional) - `GetDomainAuthorization.response.503.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDomainAuthorization.response.503.error.quota.scopeResourceName` (string, optional) - `GetDomainAuthorization.response.503.error.quota.used` (integer, optional) - min 0 - `GetDomainAuthorization.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. Source: https://docs.ezghcloud.com/certificates-api/GetDomainAuthorization/index.md