Set Organization Asset Expiry

Set organization asset expiry

curl --request POST \
  --url https://app.chainpatrol.io/api/v2/organization/assets/expiry \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "assetIds": [
    1
  ],
  "expiresAt": "2023-11-07T05:31:56Z",
  "slug": "<string>"
}
'

import requests

url = "https://app.chainpatrol.io/api/v2/organization/assets/expiry"

payload = {
    "assetIds": [1],
    "expiresAt": "2023-11-07T05:31:56Z",
    "slug": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({assetIds: [1], expiresAt: '2023-11-07T05:31:56Z', slug: '<string>'})
};

fetch('https://app.chainpatrol.io/api/v2/organization/assets/expiry', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chainpatrol.io/api/v2/organization/assets/expiry",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'assetIds' => [
        1
    ],
    'expiresAt' => '2023-11-07T05:31:56Z',
    'slug' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chainpatrol.io/api/v2/organization/assets/expiry"

	payload := strings.NewReader("{\n  \"assetIds\": [\n    1\n  ],\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"slug\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.chainpatrol.io/api/v2/organization/assets/expiry")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"assetIds\": [\n    1\n  ],\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"slug\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chainpatrol.io/api/v2/organization/assets/expiry")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assetIds\": [\n    1\n  ],\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"slug\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "updatedCount": 123,
  "expiresAt": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

POST

organization

assets

expiry

Set organization asset expiry

curl --request POST \
  --url https://app.chainpatrol.io/api/v2/organization/assets/expiry \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "assetIds": [
    1
  ],
  "expiresAt": "2023-11-07T05:31:56Z",
  "slug": "<string>"
}
'

import requests

url = "https://app.chainpatrol.io/api/v2/organization/assets/expiry"

payload = {
    "assetIds": [1],
    "expiresAt": "2023-11-07T05:31:56Z",
    "slug": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({assetIds: [1], expiresAt: '2023-11-07T05:31:56Z', slug: '<string>'})
};

fetch('https://app.chainpatrol.io/api/v2/organization/assets/expiry', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chainpatrol.io/api/v2/organization/assets/expiry",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'assetIds' => [
        1
    ],
    'expiresAt' => '2023-11-07T05:31:56Z',
    'slug' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chainpatrol.io/api/v2/organization/assets/expiry"

	payload := strings.NewReader("{\n  \"assetIds\": [\n    1\n  ],\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"slug\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.chainpatrol.io/api/v2/organization/assets/expiry")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"assetIds\": [\n    1\n  ],\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"slug\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chainpatrol.io/api/v2/organization/assets/expiry")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assetIds\": [\n    1\n  ],\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"slug\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "updatedCount": 123,
  "expiresAt": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Overview

Set, renew or clear when assets drop off your organization’s allowlist. Use it for assets that should only stay for a while, such as a partner’s website. When an asset’s expiry passes, it stays allowed and on your organization for a 14-day grace period, then it is removed from your organization and monitoring for it stops. Its status does not change. Organization owners and admins get a daily email digest about upcoming expiries and removals. See Expiry for the full timeline.

Setting a date on an expired asset renews it and ends its grace period.
Passing null clears the expiry, so the assets stay indefinitely.
The request is all or nothing: if any asset is not on your organization, nothing changes.

Quick Start

Authentication

Include your API key in the X-API-KEY header:

X-API-KEY: your_api_key_here

An organization API key needs read and write access. With user credentials, pass slug; you must be an owner or admin of that organization.

Example Request

const response = await fetch(
  "https://app.chainpatrol.io/api/v2/organization/assets/expiry",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "X-API-KEY": "YOUR_API_KEY_HERE",
    },
    body: JSON.stringify({
      assetIds: [12345, 12346],
      expiresAt: "2027-04-30T23:59:59Z",
    }),
  }
);

const data = await response.json();
console.log(data);

import requests

response = requests.post(
    "https://app.chainpatrol.io/api/v2/organization/assets/expiry",
    headers={
        "Content-Type": "application/json",
        "X-API-KEY": "YOUR_API_KEY_HERE",
    },
    json={
        "assetIds": [12345, 12346],
        "expiresAt": "2027-04-30T23:59:59Z",
    },
)

print(response.json())

curl -X POST 'https://app.chainpatrol.io/api/v2/organization/assets/expiry' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "assetIds": [12345, 12346],
    "expiresAt": "2027-04-30T23:59:59Z"
  }'

To clear the expiry, send "expiresAt": null.

Request Body

Field	Type	Required	Description
assetIds	number[]	Yes	IDs of your organization’s assets, 1 to 5000 per request. Get them from List Organization Assets.
expiresAt	string \| null	Yes	When the assets expire, as an ISO 8601 date-time in the future. `null` clears the expiry.
slug	string	No	Organization slug. Optional for organization API keys; required when your credentials can reach more than one organization.

Response

Success Response

{
  "updatedCount": 2,
  "expiresAt": "2027-04-30T23:59:59.000Z"
}

Response Fields

Field	Type	Description
updatedCount	number	Number of assets updated
expiresAt	string \| null	The expiry that was set, or `null` when it was cleared

The List Organization Assets response shows each asset’s allowlistExpiresAt, and allowlistExpiredAt once its grace period has started.

Error Responses

400 Bad Request

Returned when expiresAt is not in the future, or the body is malformed:

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "`expiresAt` must be in the future"
  }
}

401 Unauthorized

Returned when no slug is passed and the credentials are not scoped to an organization:

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Pass `slug` to choose an organization, or authenticate with an API key scoped to one"
  }
}

403 Forbidden

Returned when the API key is read-only, belongs to a different organization than slug, or the user is not an owner or admin of the organization.

404 Not Found

Returned when any of the assets is not on your organization. Nothing is changed:

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Assets not found on this organization: 12346"
  }
}

Use Cases

Expire partner assets after a year

const oneYearFromNow = new Date();
oneYearFromNow.setUTCFullYear(oneYearFromNow.getUTCFullYear() + 1);
oneYearFromNow.setUTCHours(23, 59, 59, 999);

await fetch("https://app.chainpatrol.io/api/v2/organization/assets/expiry", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-KEY": "YOUR_API_KEY_HERE",
  },
  body: JSON.stringify({
    assetIds: partnerAssetIds,
    expiresAt: oneYearFromNow.toISOString(),
  }),
});

From the CLI or MCP

chainpatrol orgs assets set-expiry 12345 12346 --in 1y

The MCP server exposes the same operation as the organization_assets_set_expiry tool.

Authorizations

X-API-KEY

string

header

required

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.

Body

application/json

Set when organization assets expire

Sets, renews or clears the allowlist expiry of assets on your organization. Use it for assets that should only stay for a while, such as a partner's site. When the date passes, the assets stay on your organization for a 14-day grace period, then are removed from it. Their status does not change. Setting a new date on an expired asset renews it and ends its grace period.

assetIds

integer[]

required

IDs of the organization's assets to update (max 5000 per request)

Required array length: 1 - 5000 elements

Required range: x > 0

expiresAt

string<date-time> | null

required

When the assets expire, as an ISO 8601 date-time in the future (e.g. 2027-04-30T23:59:59Z). null clears the expiry so the assets stay indefinitely.

slug

string

Organization slug. Optional for organization-scoped API keys, which resolve the organization from the key itself. Required when your credentials can reach more than one organization.

Response

Successful response

Expiry update result

updatedCount

number

required

Number of assets updated

expiresAt

string | null

required

The expiry that was set, or null when it was cleared

Getting Started

Assets

Reports

Disputes

Webhooks

Organization Brands

Organization Assets

Organization Asset Groups

Organization Reports

Threat Detection

Dark Web

Takedowns

Metrics

Account & Access

Operations

Staff

Healthchecks

Set Organization Asset Expiry

Overview

Quick Start

Authentication

Example Request

Request Body

Response

Success Response

Response Fields

Error Responses

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

Use Cases

Expire partner assets after a year

From the CLI or MCP

Authorizations

Body

Response

​Overview

​Quick Start

​Authentication

​Example Request

​Request Body

​Response

​Success Response

​Response Fields

​Error Responses

​400 Bad Request

​401 Unauthorized

​403 Forbidden

​404 Not Found

​Use Cases

​Expire partner assets after a year

​From the CLI or MCP

Authorizations

Body

Response

Overview

Quick Start

Authentication

Example Request

Request Body

Response

Success Response

Response Fields

Error Responses

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

Use Cases

Expire partner assets after a year

From the CLI or MCP