Skip to main content
API docs by Redocly

Domain API (v1)

Download OpenAPI specification:Download

  • Base URL: https://api.signicat.com/domain-management/
  • Documentation: See the Domains developer documentation.
  • Support: Create a support ticket in the Signicat Dashboard.

Introduction

The Signicat Domain Management API enables you to manage the domains of your Signicat accounts.

This API is part of our management APIs, which allow you to programmatically manage configurations that are typically handled in the Signicat Dashboard.

This REST API uses the OAuth 2.0 protocol for authorisation. All request and response bodies are formatted in JSON.

Domain

List domains

Responses

Response samples

Content type
{
  • "data": [
    ]
}

Add domain

Request Body schema: application/json
required
domain
string
domainKind
required
string
Enum: "SignicatManaged" "CustomerManaged"
makeDefault
boolean or null
requireMutualTls
boolean or null
object or null

Additional parameters required when domainKind equals CustomerManaged

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "domainKind": "SignicatManaged",
  • "makeDefault": true,
  • "requireMutualTls": true,
  • "customerManagedParameters": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "accountId": "string",
  • "domain": "string",
  • "domainKind": "SignicatManaged",
  • "requireMutualTls": true,
  • "customerManagedParameters": {
    },
  • "tlsState": "NotReady",
  • "dnsState": "NotReady",
  • "isDefaultDomain": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z"
}

Retrieve domain

path Parameters
domainId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "accountId": "string",
  • "domain": "string",
  • "domainKind": "SignicatManaged",
  • "requireMutualTls": true,
  • "customerManagedParameters": {
    },
  • "tlsState": "NotReady",
  • "dnsState": "NotReady",
  • "isDefaultDomain": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z"
}

Delete domain

path Parameters
domainId
required
string

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Check DNS status

path Parameters
domainId
required
string

Responses

Response samples

Content type
{
  • "records": [
    ],
  • "valid": true
}

Change certificate

Only available for custom domains using custom certificates

path Parameters
domainId
required
string
Request Body schema: application/json
certificateId
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "certificateId": "string"
}

Set default domain

path Parameters
domainId
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Utility

Check DNS status

Request Body schema: application/json
domain
required
string non-empty

The domain to check

certificateKind
required
string
Enum: "LetsEncrypt" "Csr" "Custom"

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "certificateKind": "LetsEncrypt"
}

Response samples

Content type
{
  • "records": [
    ],
  • "valid": true
}

Check domain availability

Request Body schema: application/json
domain
required
string non-empty

The domain to check

kind
required
string
Enum: "SignicatManaged" "CustomerManaged"

The kind of domain to check

requireMutualTls
boolean or null

Whether the domain will use mTLS or not. Required when Kind = CustomerManaged

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "kind": "SignicatManaged",
  • "requireMutualTls": true
}

Response samples

Content type
{
  • "valid": true,
  • "error": "string",
  • "code": "Valid"
}

Get signicat subdomain suffix

Responses

Response samples

Content type
{
  • "suffix": "string",
  • "mtlsSuffix": "string"
}