Service Policies API
Service Policies API is used for viewing and managing service policies.
GET endpoints in this API are designed with a high degree of flexibility. This section will explain how to make use of this.
A GET request returns information associated with the requested resource. This information is found in the attributes property in the response body. All properties marked as required will be returned.
Certain GET endpoints includes a property named relationships in the response body. The relationships property contains URL paths to all related resources. These paths can be used to perform HTTP GET requests in order to fetch the data belonging to the related resource.
Some GET endpoints that includes the property named relationships supports the query parameter include with different values being allowed on different endpoints. Setting the include query parameter will result in the attributes property being added to the corresponding relationship. This is great if you know that you need information which is spread out across many different resources. Instead of making multiple API requests you can use the include query parameter to get a lot of data at once in the relationships property. Note that using this query parameter may lead to longer response times so only include what you actually need.
Authentication
- Token Authorizer
| Security Scheme Type: | http |
|---|---|
| HTTP Authorization Scheme: | bearer |
| Bearer format: | JWT |