GoDaddy
Support
API ReferenceDomains & DNSv2Domains API Usage

Domains API Usage

View as Markdown

Retrieve monthly API request usage counts for your account. Data is retained for three months.

Retrieve api usage request counts for a specific year/month. The data is retained for a period of three months.

GET
/v2/domains/usage/{yyyymm}

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

yyyymm*string

The year/month timeframe for the request counts (in the format yyyy-mm)

Match^\d{4}-\d{2}$

Query Parameters

includes?array<>

Determines if the detail records (grouped by request path) are included in the response

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/domains/usage/string"
{  "details": [    {      "path": "string",      "total": 0    }  ],  "quota": 0,  "total": 0,  "yyyymm": "string"}

Agent & Automation Notes

Scopesdomains.domain:read, domains.domain:create, domains.domain:update, domains.contact:update, domains.nameserver:update, domains.transfer:execute, domains.transfer:update, domains.forward:update
Rate limit60 req/min per credential
On failureAsync operations return 202 with an Action object. Poll until terminal state. Do not resubmit transfers.

Related

Last updated on

How is this guide?