Skip to main content
API docs by Redocly

PTR Records API (1.0.0)

Managing reverse resource records of public IP addresses

Pointers

Get a list of reverse records

By default, the maximum number of records returned in the response is 1000

To work with a larger number of records, you need to use the limit and offset parameters

query Parameters
limit
integer (Limit) >= 1
Default: 1000
offset
integer (Offset) >= 0
Default: 0
filter
string (Filter)
only-count
boolean (Only-Count)
Default: false
header Parameters
X-Token
string (X-Token)
Default:

Authorization token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create reverse record

Create a PTR record

header Parameters
X-Token
string (X-Token)
Default:

Authorization token

Request Body schema: application/json
required
ip
required
string (Ip)
content
string (Content) [ 2 .. 65534 ] characters
Default: ""
ttl
integer (Ttl) [ 60 .. 604800 ]
Default: 86400

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "content": "",
  • "ttl": 86400
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "ip": "string",
  • "user_id": 0,
  • "ttl": 0
}

Get information about specified record

Get information about a specified PTR record

path Parameters
ptr_id
required
integer (Ptr Id)
header Parameters
X-Token
string (X-Token)
Default:

Authorization token

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "ip": "string",
  • "user_id": 0,
  • "ttl": 0
}

Update reverse record

Update the reverse record

path Parameters
ptr_id
required
integer (Ptr Id)
header Parameters
X-Token
string (X-Token)
Default:

Authorization token

Request Body schema: application/json
required
ip
string (Ip)
content
string (Content)

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "ip": "string",
  • "user_id": 0,
  • "ttl": 0
}

Delete reverse record

Delete the PTR record

path Parameters
ptr_id
required
integer (Ptr Id)
header Parameters
X-Token
string (X-Token)
Default:

Authorization token

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "description": "string",
  • "location": "string"
}