integrationInstanceIdstringrequired
The id of the integration instance.
Example:004d6d17-d21f-4518-89a2-b9177cb5485c
Get a Resource Ingestion
Fetches a resource ingestion job for the given integration instance.
get
Path Parameters
Response
application/json
Response
application/json
A response containing the resource ingestion status.
ResourceIngestionStatus
The resource ingestion status.
* Additional properties are NOT allowed.
last_scheduledstring | null(date-time)required
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.
get/integration-instances/{integrationInstanceId}/resource-ingestion
Authentication
Path Parameters
application/json
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.
get
Query Parameters
pageobject
Determines which page of the collection to retrieve.
Show Child Parameters
filterobject
Filters a collection of resource actions.
* Additional properties are NOT allowed.
Show Child Parameters
Response
application/json
Response
application/json
A paginated list response for a collection of resource actions.
* Additional properties are NOT allowed.
metaobjectrequired
Pagination metadata.
Show Child Parameters
dataarray[object]required
Contains information about a resource action
* Additional properties are NOT allowed.
Show Child Parameters
get/resource-actions
Authentication
Query Parameters
application/json
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.
post
Path Parameters
integrationInstancestringrequired
The id of the integration instance.
Example:3321067c-407f-417b-8aac-cd2c5ec92d85
Body
application/json
Body
application/json
Request body schema for an integration instance proxy request.
* Additional properties are NOT allowed.
methodstringrequired
The HTTP request method.
Allowed values:DELETEGETPATCHPOSTPUT
Example:GET
base_urlstring(uri)required
The base URL of the proxied API as defined in the integration manifest.
Example:https://api.pagerduty.com
pathstringrequired
The URL path of the proxied API request as defined in the integration manifest.
Example:/incidents
bodyobject
JSON object representing the request body that will be sent to the proxied API.
Example:{"name":"Foo"}
* Additional properties are allowed.
queryobject
JSON object representing the query parameters that will be sent to the proxied API.
Example:{"limit":5,"offset":10}
* Additional properties are allowed.
headersobject
JSON object representing the request headers that will be sent to the proxied API.
Example:{"content-type":"application/json"}
* Additional properties are allowed.
Response
application/problem+json
Response
application/problem+json
Error response indicating the proxy request could not be sent due to invalid state of the request body or integration instance
Any Ofstatusintegerrequiredread-only
The 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.
titlestringrequiredread-only
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.
typestringread-only
The error type.
instancestringrequiredread-only
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.
detailstringrequiredread-only
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.
invalid_parameters
One Ofarrayrequiredunique-items
invalid parameters
>= 1 items
InvalidParameterStandardobject
* Additional properties are NOT allowed.
Show Child Parameters
post/integration-instances/{integrationInstance}/proxy
Authentication
Path Parameters
Body
{
"method": "GET",
"base_url": "https://api.pagerduty.com",
"path": "/incidents"
}
application/problem+json