Retrieve a list of domain statuses.
Retrieve a list of domain statuses through the following request:
HTTP Method | Request URI |
---|---|
GET |
https://api.vdms.io/sec/cps/v2.0/appendix/domain-statuses |
This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.
Unlike requests to api.edgecast.com, requests to our API gateway (api.vdms.io) require an access token (OAuth).
Request body parameters are not required by this endpoint.
The response to the above request includes an HTTP status code, response headers, and a response body.
A status code indicates whether the request was successfully performed.
The response for this endpoint only includes standard HTTP response headers.
The response body for a successful request (200 OK) contains the following response elements:
Name | Data Type | Description |
---|---|---|
@id |
String |
Indicates the relative path to an endpoint through which you may retrieve a list of domain statuses. |
@type |
String |
Returns Collection. |
items |
Array of objects |
Contains a list of domain statuses. |
total_items |
Integer |
Indicates the total number of domain statuses. |
The items array describes each domain status through the following properties:
Name | Data Type | Description |
---|---|---|
name |
String |
Indicates the name of a domain status. |
id |
Integer |
Indicates the system-defined ID for a domain status. |
The response body for an unsuccessful request will contain an error response that provides additional information.
A sample JSON request is shown below.
GET https://api.vdms.io/sec/cps/v2.0/appendix/domain-statuses HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: api.vdms.io
A sample JSON response is shown below.
HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Type: application/json; charset=utf-8
Date: Thu, 15 Apr 2021 12:00:00 GMT
Content-Length: 656
{ "@id": "/v2.0/appendix/domain-statuses", "@type": "Collection", "items": [{ "name": "ProvisioningInitiated", "id": 2 }, { "name": "AwaitingCertificateAuthority", "id": 3 }, { "name": "Active", "id": 4 }, { "name": "PendingDelete", "id": 5 }, { "name": "Delete", "id": 6 }, { "name": "PendingDns", "id": 8 }, { "name": "Rejected", "id": 9 }, { "name": "TimedOut", "id": 10 }, { "name": "PendingReissue", "id": 11 }, { "name": "PendingDeleteFromSan", "id": 12 }, { "name": "SecretRejected", "id": 13 } ], "total_items": 11 }