Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.snyk.io/rest
/groups/{group_id}/apps/installs
Install a Snyk Apps to this group, the Snyk App must use unattended authentication eg client credentials.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| group_id | path | required | string | Group ID |
App Install to be created
application/vnd.api+json
AppsInstallGroupAppRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | optional |
| relationships | object | required |
| └ app | object | required |
| └ data | object | required |
| └ id | string | required |
| └ type | string | required |
The newly created app install.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token or a token with more permissions.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
POST /groups/{group_id}/apps/installs
/groups/{group_id}/apps/installs/{install_id}/secrets
Manage client secret for non-interactive Snyk App installations.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| group_id | path | required | string | Group ID |
| install_id | path | optional | Install ID |
application/vnd.api+json
AppsCreateInstallSecretRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | required |
| └ attributes | object | required |
| └ mode | string | required |
| └ secret | string | optional |
Secret has been updated.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token or a token with more permissions.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
POST /groups/{group_id}/apps/installs/{install_id}/secrets
/orgs/{org_id}/apps/creations
Create a new Snyk App for an organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| org_id | path | required | string | Org ID |
Snyk App details for app to be created.
application/vnd.api+json
AppPostRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | required |
| └ attributes | object | required |
| └ name | string | required |
| └ scopes | array | required |
| └ context | string | required |
| └ redirect_uris | array | required |
| └ access_token_ttl_seconds | number | optional |
Created Snyk App successfully.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token or a token with more permissions.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/apps/creations
/orgs/{org_id}/apps/creations/{app_id}/secrets
Manage client secret for the Snyk App.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| org_id | path | required | string | Org ID |
| app_id | path | optional | App ID |
application/vnd.api+json
AppsManageClientSecretForSnykAppRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | required |
| └ attributes | object | required |
| └ mode | string | required |
| └ secret | string | optional |
Secret has been updated.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token or a token with more permissions.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/apps/creations/{app_id}/secrets
/orgs/{org_id}/apps/installs
Install a Snyk Apps to this organization, the Snyk App must use unattended authentication eg client credentials.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| org_id | path | required | string | Org ID |
App Install to be created
application/vnd.api+json
AppsInstallSnykAppToOrgRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | optional |
| relationships | object | required |
| └ app | object | required |
| └ data | object | required |
| └ id | string | required |
| └ type | string | required |
The newly created app install.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token or a token with more permissions.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/apps/installs
/orgs/{org_id}/apps/installs/{install_id}/secrets
Manage client secret for non-interactive Snyk App installations.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| org_id | path | required | string | Org ID |
| install_id | path | optional | Install ID |
application/vnd.api+json
AppsManageClientSecretForSnykAppRequest1
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | required |
| └ attributes | object | required |
| └ mode | string | required |
| └ secret | string | optional |
Secret has been updated.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token or a token with more permissions.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/apps/installs/{install_id}/secrets
/orgs/{org_id}/collections
Create a collection
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| org_id | path | required | string | Org ID |
application/vnd.api+json
CreateCollectionRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | required |
| └ attributes | object | required |
| └ name | string | required |
Returned collection
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/collections
/orgs/{org_id}/collections/{collection_id}/relationships/projects
Add projects to a collection by specifying an array of either project ids or target ids (for targets, the respective projects will be added, but they won’t be updated when the target changes)
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| org_id | path | required | string | Org ID |
| collection_id | path | optional | string | Unique identifier for a collection |
application/vnd.api+json
UpdateCollectionWithProjectsRequest
| Property | Type | Required |
|---|---|---|
| data | array | required |
| └ id | string | required |
| └ type | string | required |
successfully adding projects to a collection
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/collections/{collection_id}/relationships/projects
/custom_base_images
In order to create a custom base image, you first need to import your base images into Snyk.
You can do this through the CLI, UI, or API.
This endpoint marks an image as a custom base image. This means that the image will get
added to the pool of images from which Snyk can recommend base image upgrades.
Note, after the first image in a repository gets added, a versioning schema cannot be passed in this endpoint.
To update the versioning schema, the PATCH endpoint must be used.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
The properties used in the creation of a custom base image
application/vnd.api+json
CustomBaseImagePostRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | required |
| └ attributes | object | required |
| └ project_id | string | required |
| └ versioning_schema | object | optional |
| └ include_in_recommendations | boolean | required |
Successfully created a custom base image
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
POST /custom_base_images
/orgs/{org_id}/invites
Invite a user to an organization with a role.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| org_id | path | required | string | The id of the org the user is being invited to |
application/vnd.api+json
InvitesUserToOrganizationRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | required |
| └ attributes | object | required |
| └ role | object | required |
| string | required | |
| └ relationships | object | optional |
| └ org | object | optional |
| └ data | object | required |
| └ meta | object | optional |
| └ links | object | required |
A new organization invitation has been created
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/invites
/orgs/{org_id}/packages/issues
This endpoint is not available to all customers. If you are interested please contact support. Query issues for a batch of packages identified by Package URL (purl). Only direct vulnerabilities are returned, transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| org_id | path | required | string | Unique identifier for an organization |
application/vnd.api+json
BulkPackageUrlsRequestBody
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | optional |
| └ attributes | object | required |
| └ purls | array | required |
Returns an array of issues with the purl identifier of the package that caused them
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/packages/issues
/groups/{group_id}/service_accounts
Create a service account for a group. The service account can be used to generate access tokens. Currently, we only allow group service accounts using default group roles.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| group_id | path | required | string | The ID of the Snyk Group that is creating and owns the service account |
| version | query | optional | The requested version of the endpoint to process the request |
application/vnd.api+json
ServiceAccountsCreateGroupRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | required |
| └ attributes | object | required |
| └ name | string | required |
| └ role_id | string | required |
| └ jwks_url | string | optional |
| └ auth_type | string | required |
| └ access_token_ttl_seconds | number | optional |
A new service account has been created
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
POST /groups/{group_id}/service_accounts
/groups/{group_id}/service_accounts/{serviceaccount_id}/secrets
Manage the client secret of a group service account by the service account ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| group_id | path | required | string | The ID of the Snyk Group that owns the service account. |
| serviceaccount_id | path | required | string | The ID of the service account. |
| version | query | optional | The requested version of the endpoint to process the request |
application/vnd.api+json
ServiceAccountsManageClientSecretRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | required |
| └ attributes | object | required |
| └ mode | string | required |
| └ secret | string | optional |
Service account client secret has been updated.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
POST /groups/{group_id}/service_accounts/{serviceaccount_id}/secrets
/orgs/{org_id}/service_accounts
Create a service account for an organization. The service account can be used to generate access tokens.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The ID of the Snyk Organization that is creating and will own the service account. |
| version | query | optional | The requested version of the endpoint to process the request |
application/vnd.api+json
ServiceAccountsCreateForOrganizationRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | optional |
| └ attributes | object | required |
| └ name | string | required |
| └ role_id | string | required |
| └ jwks_url | string | optional |
| └ auth_type | string | required |
| └ access_token_ttl_seconds | number | optional |
A new service account has been created
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/service_accounts
/orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets
Manage the client secret of an organization-level service account by the service account ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The ID of the Snyk Organization that owns the service account. |
| serviceaccount_id | path | required | string | The ID of the service account. |
| version | query | optional | The requested version of the endpoint to process the request |
application/vnd.api+json
ServiceAccountsManageClientSecretForOrganizationServiceAccountRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | required |
| └ attributes | object | required |
| └ mode | string | required |
| └ secret | string | optional |
Service account client secret has been updated.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets
/orgs/{org_id}/slack_app/{bot_id}
Create new Slack notification default settings for a given tenant.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| org_id | path | required | string | Org ID |
| bot_id | path | optional | Bot ID |
Create new Slack notification default settings for a tenant.
application/vnd.api+json
SettingsRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | required |
| └ attributes | object | required |
| └ target_channel_id | string | required |
| └ severity_threshold | string | required |
Default settings created successfully
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/slack_app/{bot_id}
/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}
Create Slack settings override for a project.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| org_id | path | required | string | Org ID |
| project_id | path | required | string | Project ID |
| bot_id | path | optional | Bot ID |
Create new Slack notification default settings for a tenant.
application/vnd.api+json
SettingsRequest
| Property | Type | Required |
|---|---|---|
| data | object | required |
| └ type | string | required |
| └ attributes | object | required |
| └ target_channel_id | string | required |
| └ severity_threshold | string | required |
Project settings created successfully
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}
AccessTokenTtlSeconds
{
"type": "number",
"example": 3600,
"maximum": 86400,
"minimum": 3600,
"description": "The access token time to live for your app, in seconds. It only affects the newly generated access tokens, existing access token will continue to have their previous time to live as expiration."
}
ActualVersion
{
"type": "string",
"pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$",
"description": "Resolved API version"
}
AppBot
{
"type": "object",
"required": [
"type",
"id",
"relationships"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"attributes": {
"type": "object"
},
"relationships": {
"type": "object",
"required": [
"app"
],
"properties": {
"app": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PublicApp"
}
}
}
}
}
}
}
AppData
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"attributes": {
"$ref": "#/components/schemas/AppResourceAttributes"
}
}
}
AppDataWithSecret
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"attributes": {
"$ref": "#/components/schemas/AppResourceAttributesWithSecret"
}
}
}
AppInstallData
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"attributes": {
"type": "object",
"properties": {
"client_id": {
"$ref": "#/components/schemas/ClientId"
}
}
},
"relationships": {
"type": "object",
"properties": {
"app": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PublicAppData"
}
}
}
}
}
}
}
AppInstallDataWithSecret
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"attributes": {
"type": "object",
"required": [
"client_id",
"client_secret"
],
"properties": {
"client_id": {
"$ref": "#/components/schemas/ClientId"
},
"client_secret": {
"$ref": "#/components/schemas/ClientSecret"
}
}
},
"relationships": {
"type": "object",
"properties": {
"app": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PublicAppData"
}
}
}
}
}
}
}
AppInstallWithClient
{
"type": "object",
"required": [
"type",
"id",
"attributes",
"relationships"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"attributes": {
"type": "object",
"required": [
"client_id",
"client_secret"
],
"properties": {
"client_id": {
"type": "string",
"format": "uuid"
},
"client_secret": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"properties": {
"app": {
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"type": {
"$ref": "#/components/schemas/Type"
}
}
}
}
}
}
}
}
}
AppName
{
"type": "string",
"example": "My App",
"minLength": 1,
"description": "New name of the app to display to users during authorization flow."
}
AppPatchRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"enum": [
"app"
],
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/AppName"
},
"redirect_uris": {
"$ref": "#/components/schemas/RedirectUris"
},
"access_token_ttl_seconds": {
"$ref": "#/components/schemas/AccessTokenTtlSeconds"
}
},
"minProperties": 1
}
}
}
}
}
AppPostRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes",
"type"
],
"properties": {
"type": {
"enum": [
"app"
],
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"name",
"redirect_uris",
"scopes",
"context"
],
"properties": {
"name": {
"$ref": "#/components/schemas/AppName"
},
"scopes": {
"$ref": "#/components/schemas/Scopes"
},
"context": {
"$ref": "#/components/schemas/Context"
},
"redirect_uris": {
"$ref": "#/components/schemas/RedirectUris"
},
"access_token_ttl_seconds": {
"$ref": "#/components/schemas/AccessTokenTtlSeconds"
}
}
}
}
}
}
}
AppPostResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppDataWithSecret"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppResourceAttributes
{
"type": "object",
"required": [
"name",
"scopes",
"access_token_ttl_seconds",
"is_public",
"is_confidential",
"context",
"grant_type"
],
"properties": {
"name": {
"$ref": "#/components/schemas/AppName"
},
"scopes": {
"$ref": "#/components/schemas/Scopes"
},
"context": {
"$ref": "#/components/schemas/Context"
},
"client_id": {
"$ref": "#/components/schemas/ClientId"
},
"is_public": {
"$ref": "#/components/schemas/IsPublic"
},
"grant_type": {
"$ref": "#/components/schemas/GrantType"
},
"org_public_id": {
"$ref": "#/components/schemas/Uuid"
},
"redirect_uris": {
"$ref": "#/components/schemas/RedirectUris"
},
"is_confidential": {
"$ref": "#/components/schemas/IsConfidential"
},
"access_token_ttl_seconds": {
"$ref": "#/components/schemas/AccessTokenTtlSeconds"
}
}
}
AppResourceAttributesWithSecret
{
"type": "object",
"required": [
"client_id",
"name",
"redirect_uris",
"scopes",
"access_token_ttl_seconds",
"is_public",
"is_confidential",
"client_secret",
"context",
"grant_type"
],
"properties": {
"name": {
"$ref": "#/components/schemas/AppName"
},
"scopes": {
"$ref": "#/components/schemas/Scopes"
},
"context": {
"$ref": "#/components/schemas/Context"
},
"client_id": {
"$ref": "#/components/schemas/ClientId"
},
"is_public": {
"$ref": "#/components/schemas/IsPublic"
},
"grant_type": {
"$ref": "#/components/schemas/GrantType"
},
"client_secret": {
"$ref": "#/components/schemas/ClientSecret"
},
"org_public_id": {
"$ref": "#/components/schemas/Uuid"
},
"redirect_uris": {
"$ref": "#/components/schemas/RedirectUris"
},
"is_confidential": {
"$ref": "#/components/schemas/IsConfidential"
},
"access_token_ttl_seconds": {
"$ref": "#/components/schemas/AccessTokenTtlSeconds"
}
}
}
AppsByInstallId401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsByInstallId403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsByInstallId404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsByInstallId409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsByInstallId500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsByInstallIdResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecret400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecret401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecret403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecret404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecret409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecret500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecretRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes",
"type"
],
"properties": {
"type": {
"enum": [
"app"
],
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"enum": [
"replace",
"create",
"delete"
],
"type": "string",
"description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n"
},
"secret": {
"type": "string",
"description": "Secret to delete when using `delete` mode"
}
}
}
}
}
}
}
AppsCreateInstallSecretResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppInstallDataWithSecret"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsCreateNewAppForOrganization401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateNewAppForOrganization403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateNewAppForOrganization404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateNewAppForOrganization409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateNewAppForOrganization500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateNewAppForOrganizationResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateOrganizationApp401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateOrganizationApp403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateOrganizationApp404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateOrganizationApp409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateOrganizationApp500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateOrganizationAppResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteAppById401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteAppById403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteAppById404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteAppById409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteAppById500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteAppByIdResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteByAppId401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteByAppId403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteByAppId404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteByAppId409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
| Version | Endpoints | Schemas | Ingested | Status |
|---|---|---|---|---|
| REST | 96 | 446 | 2026-05-11 | current |
| REST | 96 | 446 | 2026-04-16 |