List a contact point usages

GET /api/contact_points/{contact_point_id}/usages

Interactive request editor loads with JavaScript.

Path Parameters

contact_point_id*string

Contact point ID.

Match^[a-zA-Z0-9-_.]+$

Length1 <= length <= 256

Query Parameters

resource_type?string

Type of notification.

Value in

"alert_policy"
"api_product_notification"

page?integer

Page number of the listed resources. Used together with page_size. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.

Formatint32

Range1 <= value

page_size?integer

Number of resources listed per page. Used together with page. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.

Formatint32

Range1 <= value

direction?string

Order to list the resources by. The sorting index follows the configuration of order_by.

Default"desc"

Value in

"asc"
"desc"

order_by?string

Index to order contact point usages by.

Default"updated_at"

Value in

"resource_name"
"resource_type"
"created_at"
"updated_at"

Response Body

`application/json`

curl -X GET "$API_BASE_URL/api/contact_points/bd58fce2-b6cc-4d2d-a53c-6ce11b19c101/usages"

Successfully retrieved the paginated list of contact point usages.

{
  "total": 1,
  "list": [
    {
      "id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
      "created_at": 1742288232,
      "updated_at": 1742288235,
      "resource_type": "alert_policy",
      "resource_id": "b32e678e-7f6b-4a50-b113-550621ed4c01",
      "resource_name": "Weather Insights API"
    }
  ]
}

Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.

{
  "value": {},
  "error_msg": "error message"
}

Complete operation details and schema variants

GET /api/contact_points/{contact_point_id}/usages

List a contact point usages

List resources that currently reference the specified contact point. Check usage before deletion or major edits to understand downstream impact.

Required IAM Permission: Action iam:GetContactPoint, Resource arn:api7:iam:contactpoint/%s

Parameters

contact_point_id (path, string, required): Contact point ID.
resource_type (query, string, optional):
page (query, integer, optional): Page number of the listed resources. Used together with page_size. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.
page_size (query, integer, optional): Number of resources listed per page. Used together with page. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.
direction (query, string, optional): Order to list the resources by. The sorting index follows the configuration of order_by.
order_by (query, string, optional): Index to order contact point usages by.

Responses

200: Successfully retrieved the paginated list of contact point usages.
allOf variant 1
list (array, optional): An array of resources.
total (integer, optional): Total number of objects.
allOf variant 2
list (array, optional): An array of contact point usages.
list[].id (string, optional): The object ID.
list[].created_at (integer, optional): The object created timestamp.
list[].updated_at (integer, optional): The object updated timestamp.
list[].resource_type (string, optional): Type of notification.
list[].resource_id (string, optional): The resource ID.
list[].resource_name (string, optional): The resource name.
400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
value (object, optional): The specific resource.
error_msg (string, optional): The error message.

cURL

curl -X GET '$API_BASE_URL/api/contact_points/{contact_point_id}/usages'

List a contact point usages

200application/json

400application/json

`application/json`

`application/json`