Delete a drop rule

DELETE

/domains/{domain}/rules/drop/{ruleId}

const url = 'https://api.nsin.ir/domains/example.com/rules/drop/1';
const options = {method: 'DELETE', 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 DELETE \
  --url https://api.nsin.ir/domains/example.com/rules/drop/1 \
  --header 'Authorization: Bearer <token>'

Deletes one drop rule and removes it from the edge immediately. A rule that does not exist, belongs to another domain or to another rule type answers 404, as does a caller without rules.edit. Requires rules.edit.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

domain

required

string

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

Example

example.com

ruleId

required

integer

Numeric id of the rule.

Responses

200

Deleted.

application/json

object

message

string

Example

{
  "message": "deleted"
}

401

Missing, malformed, revoked or expired API key. (A valid key whose account has been deactivated gets 403 account is inactive instead.)

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

The key is read-only and this endpoint is a write. Read-only keys may only issue GET, HEAD and OPTIONS.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

readOnly

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

404

The domain or the rule does not exist, the rule belongs to another domain or another rule type, or your role does not permit this operation.

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"
}