Ask NSIN to issue a certificate as well

POST

/domains/{domain}/ssl/certificates/request

const url = 'https://api.nsin.ir/domains/example.com/ssl/certificates/request';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.nsin.ir/domains/example.com/ssl/certificates/request \
  --header 'Authorization: Bearer <token>'

Uploading a certificate keeps its hostnames out of every automatic order — NSIN must not silently replace material you installed on purpose — so a domain that uploaded before NSIN ever issued for it has no certificate of ours at all, and nothing to choose between. This asks for one.

Your certificate keeps serving throughout: the new one fills the automatic slot behind it, and you switch over with POST /domains/{domain}/ssl/certificates/{certificateId}/select when you are ready. From then on the name stays in our renewals, so whichever one you are not serving stays valid.

Returns immediately with status: "pending"; poll GET /domains/{domain}/ssl/certificates. Requires ssl.manage and a plan that includes custom certificates.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

domain

required

string

The domain name (for example example.com) — not a numeric id.

Example

example.com

Responses

200

Issuance started.

application/json

object

message

string

status

string

Example

{
  "status": "pending"
}

400

NSIN already holds a certificate for this domain (select it instead), or an external-DNS domain has not delegated _acme-challenge yet.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

401

Missing, malformed, revoked or expired API key — or the owning account is inactive.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

invalidKey

{
  "error": "invalid API key"
}

403

Read-only key, insufficient role, or the plan does not include custom certificates.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

404

No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

409

A certificate has already been requested and is on its way.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

429

The key exceeded its request budget (300 requests per minute by default).

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

limited

{
  "error": "rate limit exceeded"
}

503

The certificate issuer is temporarily unavailable.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}