List sinkholes owned by this account

/accounts/{account_identifier}/intel/sinkholes

get

Sinkhole Config

sinkhole-config-get-sinkholes

Debug "planAvailability"

null

Debug "tokenPermissions"

null

Debug "parameters"

[
  {
    "in": "path",
    "name": "account_identifier",
    "required": true,
    "schema": {
      "description": "Identifier",
      "example": "023e105f4ecef8ad9ca31a8372d0c353",
      "maxLength": 32,
      "readOnly": true,
      "type": "string"
    }
  }
]

Debug "requestBody"

null

Debug "responses"

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "allOf": [
            {
              "properties": {
                "errors": {
                  "example": [],
                  "items": {
                    "properties": {
                      "code": {
                        "minimum": 1000,
                        "type": "integer"
                      },
                      "message": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "code",
                      "message"
                    ],
                    "type": "object",
                    "uniqueItems": true
                  },
                  "type": "array"
                },
                "messages": {
                  "example": [],
                  "items": {
                    "properties": {
                      "code": {
                        "minimum": 1000,
                        "type": "integer"
                      },
                      "message": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "code",
                      "message"
                    ],
                    "type": "object",
                    "uniqueItems": true
                  },
                  "type": "array"
                },
                "result": {
                  "anyOf": [
                    {
                      "type": "object"
                    },
                    {
                      "items": {},
                      "type": "array"
                    },
                    {
                      "type": "string"
                    }
                  ]
                },
                "success": {
                  "description": "Whether the API call was successful",
                  "enum": [
                    true
                  ],
                  "example": true,
                  "type": "boolean"
                }
              },
              "required": [
                "success",
                "errors",
                "messages",
                "result"
              ],
              "type": "object"
            },
            {
              "properties": {
                "result": {
                  "example": [
                    {
                      "account_tag": "233f45e61fd1f7e21e1e154ede4q2859",
                      "created_on": "2023-05-12T12:21:56.777653Z",
                      "description": "user specified description 1",
                      "id": 1,
                      "modified_on": "2023-06-18T03:13:34.123321Z",
                      "name": "sinkhole_1",
                      "r2_bucket": "my_bucket",
                      "r2_id": "<r2_id>"
                    },
                    {
                      "account_tag": "233f45e61fd1f7e21e1e154ede4q2859",
                      "created_on": "2023-05-21T21:43:52.867525Z",
                      "description": "user specified description 2",
                      "id": 2,
                      "modified_on": "2023-06-28T18:46:18.764425Z",
                      "name": "sinkhole_1",
                      "r2_bucket": "my_bucket",
                      "r2_id": "<r2_id>"
                    }
                  ],
                  "items": {
                    "example": {
                      "account_tag": "233f45e61fd1f7e21e1e154ede4q2859",
                      "created_on": "2023-05-12T12:21:56.777653Z",
                      "description": "user specified description 1",
                      "id": 1,
                      "modified_on": "2023-06-18T03:13:34.123321Z",
                      "name": "sinkhole_1",
                      "r2_bucket": "my_bucket",
                      "r2_id": "<r2_id>"
                    },
                    "properties": {
                      "account_tag": {
                        "description": "The account tag that owns this sinkhole",
                        "type": "string"
                      },
                      "created_on": {
                        "description": "The date and time when the sinkhole was created",
                        "format": "date-time",
                        "type": "string"
                      },
                      "id": {
                        "description": "The unique identifier for the sinkhole",
                        "type": "integer"
                      },
                      "modified_on": {
                        "description": "The date and time when the sinkhole was last modified",
                        "format": "date-time",
                        "type": "string"
                      },
                      "name": {
                        "description": "The name of the sinkhole",
                        "type": "string"
                      },
                      "r2_bucket": {
                        "description": "The name of the R2 bucket to store results",
                        "type": "string"
                      },
                      "r2_id": {
                        "description": "The id of the R2 instance",
                        "type": "string"
                      }
                    }
                  },
                  "type": "array"
                }
              }
            }
          ]
        }
      }
    },
    "description": "Successful Response"
  }
}

Debug "security"

[
  {
    "api_email": [],
    "api_key": []
  }
]