List Contact Points

GET /api/contact_points

List Contact Points

List contact points available for alert notification delivery. Use filters and pagination to locate channels by type, labels, or search terms.

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

Parameters

• type (query, string, optional):
• labels (query, string, optional): Label(s) to filter resources by. The format is labels[key]=value and should be URL-encoded.
• search (query, string, optional): Condition to search resources by.
• order_by (query, string, optional): Index to order resources by.
• direction (query, string, optional): Order to list the resources by. The sorting index follows the configuration of order_by.
• 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.

Responses

• 200: Successfully retrieved the paginated list of contact points.
• 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 points.
• allOf variant 1
• allOf variant 1
• list[].name (string, optional): Name of the contact point.
• list[].desc (string, optional): The object description.
• list[].labels (object, optional): Key-value pairs of labels.
• allOf variant 2
• oneOf variant 1: Email
• list[].type (string, optional): Type of contact point.
• list[].email_config (object, required): Contact point email configurations.
• list[].email_config.email (array, optional):
• oneOf variant 2: Webhook
• list[].type (string, optional): Type of contact point.
• list[].webhook_config (object, required): Contact point webhook configurations.
• list[].webhook_config.ssl_verify (boolean, optional): If true, perform SSL verification.
• list[].webhook_config.url (string, optional): Webhook URL.
• list[].webhook_config.method (string, optional): HTTP method of the webhook request.
• list[].webhook_config.headers (array, optional): Extra HTTP headers to take when sending requests.
• list[].webhook_config.headers[].name (string, required):
• list[].webhook_config.headers[].value (string, required):
• allOf variant 2
• 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.
• 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'