Get a Resource Ingestion
Fetches a resource ingestion job for the given integration instance.
Path Parameters
The id of the integration instance.
Example:004d6d17-d21f-4518-89a2-b9177cb5485c
Response
application/json
Response
A response containing the resource ingestion status.
ResourceIngestionStatus
The resource ingestion status.
The timestamp denoting when the last ingestion job was run.
RFC-3339 format is used with a “T” character separating date from time within the field value.
A null value denotes that ingestion for the given integration was never run.
The timestamp denoting when the ingestion job is scheduled to run.
RFC-3339 format is used with a “T” character separating date from time within the field value.
A null value denotes that ingestion for the given integration is not scheduled to run.
One OfDescribes the resource ingestion scheduler state.
Show Child Parameters
Authentication
Path Parameters
Resource Actions
Resource actions provides an overview of actions taken on resources.
It provides information on when one of the following actions are taken on a resource:
- Map
- Unmap
- Archive
- Restore
List Resource Actions
Returns a paginated collection of a resource actions.
Query Parameters
Determines which page of the collection to retrieve.
Show Child Parameters
Filters a collection of resource actions.
Show Child Parameters
Response
application/json
Response
A paginated list response for a collection of resource actions.
Pagination metadata.
Show Child Parameters
Contains information about a resource action
Show Child Parameters
Authentication
Query Parameters
Integration Instance Proxy
The integration instance proxy allows requests to be made to the authorized integration instance.
The APIs which are allowed to be proxied to the integration instances are defined in the proxies section of the Integration.
Integration Instance Proxy Request
Proxies a request to an external API for the integration instance.
Path Parameters
The id of the integration instance.
Example:3321067c-407f-417b-8aac-cd2c5ec92d85
Body
application/json
Body
Request body schema for an integration instance proxy request.
The HTTP request method.
Allowed values:DELETEGETPATCHPOSTPUT
Example:GET
The base URL of the proxied API as defined in the integration manifest.
Example:https://api.pagerduty.com
The URL path of the proxied API request as defined in the integration manifest.
Example:/incidents
JSON object representing the request body that will be sent to the proxied API.
Example:{"name":"Foo"}
JSON object representing the query parameters that will be sent to the proxied API.
Example:{"limit":5,"offset":10}
JSON object representing the request headers that will be sent to the proxied API.
Example:{"content-type":"application/json"}
Response
application/problem+json
Response
Error response indicating the proxy request could not be sent due to invalid state of the request body or integration instance
Any OfThe HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.
A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.
The error type.
Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.
A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.
One Ofinvalid parameters
>= 1 items