Reading an area page in our API docs: the guide on top, the operations below and the filter

The short answer: each API area (Domains, DNS, SMS, Invoices and credit, and the rest) has a page with two parts. At the top, the guide: what you need and how each task is done. Below it, the list of operations, each with everything you need to call it.

The guide, at the top

Almost every page opens with "What you need", which gives the permission your key must have and, where it applies, the service your account must have active. Then come sections by task, with links to the operations. Some pages end with "What is planned": the list of what does not exist in the API yet and, for now, is done in My MozOut. The reading time at the top of the page refers to this guide.

The list of operations, below

1	Each line shows the method, the name and the path, such as GET "List DNS records".

2	Click the line to open it. You get the full address of the operation, with a Copy button, and the Playground button, which opens the test panel right there.

3	Below that comes the explanation of the operation: authentication, parameters, request body, examples, responses and errors. See how to read an operation.

Method	What it usually means
GET	Read: list items or see one. It changes nothing.
POST	Create or ask for an action: send an SMS, register a domain, open a support ticket.
PUT	Change: the nameservers, auto-renewal, a DNS record.
DELETE	Delete: a DNS record, for example.

Going straight to an operation

Every operation has its own address. The link symbol next to its name copies it; anyone who opens that address lands on the area page with the operation already open. It is the quickest way to tell a colleague "this one".

The filter

On areas with many operations you get a "Filter the operations of this area" box. Type part of the name, the path or the method: the list shrinks as you type, and Enter opens the first one left.

Parts of the path in curly brackets are your own values. In /v1/domains/{domain}/dns, {domain} is your domain name, for example yourcompany.com.

See the list of areas and pick the one you are automating.

See the API areas

Categories

Categories