Domain OPI

Provides information about domains on the account in JSON format.

Request URL

https://opsat.net/opi/domain

Supported Verbs

GET
LIST
POST
DELETE

GET /opi/domain

Inputs

apikey: string - valid API key
domain: string - domain name to get

Errors

0 - OK

1 - Invalid API Key

2 - OPI not enabled on current plan

50 - No Domain Specified

100 - Domain Not Found In Account

Output

{
	"error": int,
	"message": string,
	"goto": string,
	"payload": {
		"Domain": {
			"UUID": string,
			"Domain": string,
			"StatusCode": int,
			"StatusWord": string,
			"CertIssuer": string,
			"CertDateIssued": string,
			"CertDateExpire": string,
			"CertDateLogged": string
		}
	}
}

cURL Example

curl "https://opsat.net/opi/domain?apikey=$OPSAT_API_KEY&domain=DOMAIN-TO-QUERY"

LIST /opi/domain

Inputs

apikey: string - valid API key

Errors

0 - OK

1 - Invalid API Key

2 - OPI not enabled on current plan

Output

{
	"error": int,
	"message": string,
	"goto": string,
	"payload": {
		"Domains": [
			{
				"UUID": string,
				"Domain": string,
				"StatusCode": int,
				"StatusWord": string,
				"CertIssuer": string,
				"CertDateIssued": string,
				"CertDateExpire": string,
				"CertDateLogged": string
			}
		]
	}
}

cURL Example

curl "https://opsat.net/opi/domain" --request LIST --data "apikey=$OPSAT_API_KEY"

POST /opi/domain

Inputs

apikey: string - valid API key
domain: string - domain name to add

Errors

0 - OK

1 - Invalid API Key

2 - OPI not enabled on current plan

50 - No Domain Specified

51 - Account is at domain count limit.

Output

{
	"error": int,
	"message": string,
	"goto": string,
	"payload": {
		"Domain": {
			"UUID": string,
			"Domain": string,
			"StatusCode": int,
			"StatusWord": string,
			"CertIssuer": string,
			"CertDateIssued": string,
			"CertDateExpire": string,
			"CertDateLogged": string
		}
	}
}

cURL Example

curl "https://opsat.net/opi/domain" --request POST --data "apikey=$OPSAT_API_KEY" --data "domain=DOMAIN-NAME"

DELETE /opi/domain

Inputs

apikey: string - valid API key
domain: string - domain name to delete

Errors

0 - OK

1 - Invalid API Key

2 - OPI not enabled on current plan

50 - No Domain Specified

Output

{
	"error": int,
	"message": string,
	"goto": string,
	"payload": object
}

cURL Example

curl "https://opsat.net/opi/domain" --request DELETE --data "apikey=$OPSAT_API_KEY" --data "domain=DOMAIN-NAME"