Retrieving zone notes using the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.
Understanding How The API Works »
REST Syntax
| Click to view all REST Resources |
| ZoneNoteReport/ POST — Generates a report containing the Zone Notes for the specified zone.
HTTP Action — POST
URI — https://api.dynect.net/REST/ZoneNoteReport |
Arguments:
- string
zone — Required. Name of zone.
- integer
limit — The number of notes to be retrieved. Limit 1000 notes.
- integer
offset — Count of the most recent notes to skip. Defaults to 0.
|
Response — Click for More Info
- string
zone — The name of the zone associated with the note(s).
- integer
serial — The serial at which this note was generated.
- string
type — The type of note; commonly “publish”, “task”, or “remove”.
- string
note — The contents of the note.
- integer
timestamp — Time of event, as a unix epoch time.
|
SOAP Syntax
| Click to view all SOAP Commands |
| GetZoneNotes — Generates a report containing the Zone Notes for the specified zone. |
Arguments — Click for More Info
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone.
- integer
limit — The number of notes to be retrieved. Limit 1000 notes.
- integer
offset — Count of the most recent notes to skip. Defaults to 0.
|
Response — Click for More Info
- array
data
- string
zone — The name of the zone associated with the note(s).
- integer
serial — The serial at which this note was generated.
- string
type — The type of note, commonly “publish”, “task”, or “remove”.
- string
note — The contents of the note.
- integer
timestamp — Time of event, as a unix epoch time.
|
Example Request — Click for More Info
{
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
'limit' => 5,
'offset' => 2
}
|
DNS API Knowledge Base
