Skip to main content
API docs by Redocly

PTR API (1.0.0)

Managing Pointer (PTR) records that enable reverse DNS mapping for public IP addresses

Pointers

Managing PTR records: creation, viewing, modification, and deletion.

List PTR records

Returns a paginated list of PTR 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.

Authorizations:
static_token
query Parameters
limit
integer (Limit) >= 1
Default: 1000

Maximum number of items to return in response. Used for pagination.

offset
integer (Offset) >= 0
Default: 0

Number of items to skip. Used for pagination.

filter
string (Filter)

Filter PTR records by domain name.

only-count
boolean (Only-Count)
Default: false

Return only the total count of PTR records.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create PTR record

Creates a PTR record using the provided attributes.

Authorizations:
static_token
Request Body schema: application/json
required
ip
required
string (Ip)

IP address for which the PTR record is created.

content
string (Content) [ 2 .. 65534 ] characters
Default: ""

Domain name that the IP address resolves to.

ttl
integer (Ttl) [ 60 .. 604800 ]
Default: 86400

Time-to-live value for DNS record in seconds. Controls how long DNS resolvers cache this record.

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
}

Retrieve PTR records information

Returns information about a specified PTR record.

Authorizations:
static_token
path Parameters
ptr_id
required
integer (Ptr Id)

PTR record identifier.

Responses

Response samples

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

Update PTR record

Updates one or more attributes of the specified PTR record.

Authorizations:
static_token
path Parameters
ptr_id
required
integer (Ptr Id)

PTR record identifier.

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

New IP address for the PTR record.

content
string (Content)

New domain name that the IP should resolve to.

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 PTR record

Deletes a PTR record by its unique identifier.

Authorizations:
static_token
path Parameters
ptr_id
required
integer (Ptr Id)

PTR record identifier.

Responses

Response samples

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