Help Center
Login Sign up
  1. Home
  2. API reference
  3. JSON
  4. JSON API basics

HTTP Header

API reference (XML/JSON) · Updated 2025-01-15

In addition to the actual data, some meta-information is exchanged in both the request and the response from the server. This is summarized in the HTTP headers.

Some headers are used only in the response from the system and have no effect in a request to the system.

X-Domainrobot-2FA-Token

The 2FA token.

Header name

 X-Domainrobot-2FA-Token

Header values

String

Usage 

Request

X-Domainrobot-Bulk-Limit

The limit for bulk requests. If the limit is smaller than the number of objects in the request, the requests are processed asynchronously.

Header name

 X-Domainrobot-Bulk-Limit

Header values

Integer,e.g. 25

Usage 

Request / Response

X-Domainrobot-Context

The AutoDNS ID of the user being used.

Header name

 X-Domainrobot-Context

Header values

Integer,e.g. 4

Usage 

Request / Response

X-Domainrobot-Ctid

The client transaction ID used to identify a request. Set by the client.

Header name

X-Domainrobot-Ctid

Header values

String

Usage 

Request

X-Domainrobot-Demo

Enable and disable demo mode.

Header name

X-Domainrobot-Demo

Header values

Boolean

true = demo mode enabled

false = demo mode disabled

Usage 

Request / Response

X-Domainrobot-Domain-Safe-Pin

The DomainSafe Pin.

Header name

X-Domainrobot-Domain-Safe-Pin

Header values

String

Usage 

Request / Response

X-Domainrobot-Domain-Safe-Transaction

The DomainSafe transaction number.

Header name

X-Domainrobot-Domain-Safe-Transaction

Header values

String

Usage 

Request / Response

X-Domainrobot-Domain-Safe-Transaction-Expire

The expiration date of the DomainSafe transaction.

Header name

X-Domainrobot-Domain-Safe-Transaction-Expire

Header values

String

date-time

Usage 

Request / Response

X-Domainrobot-Domain-Safe-Tan

The DomainSafe TAN.

Header name

X-Domainrobot-Domain-Safe-Tan

Header values

String

letters and digits

Usage 

Request / Response

X-Domainrobot-Owner-User

The Personal AutoDNS ID of the subordinate user.

Header name

X-Domainrobot-Owner-User

Header values

String

Usage 

Request / Response

X-Domainrobot-Owner-Context

The Personal AutoDNS ID of the subordinate user.

Header name

X-Domainrobot-Owner-Context

Header values

Integer, e.g. 4

Usage 

Request /R esponse

X-Domainrobot-SessionId

The session ID from the POST /login route.

Header name

X-Domainrobot-SessionId

Header values

String

Usage 

Request / Response

X-Domainrobot-Stid

The server transaction ID, which is a unique ID used to identify a request. It is generated by the system.

Header name

X-Domainrobot-Stid

Header values

String

Usage 

Response

X-Domainrobot-WS

Specifies whether messages should be sent to Websocket or not.

Header name

X-Domainrobot-WS

Header values

String

Possible values: 

  • BOTH = Task and asynchronous job

  • ASYNC = Asynchronous job only

  • NONE = Nothing is sent

Usage 

Request / Response

X-Domainrobot-WS-Target

Specifies where to send messages to the websocket (session or user).

Header name

X-DomainRobot-WS-Target

Header values

Enum

Possible values:

  • USER
  • SESSION

Usage 

Request / Response