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_id}
Revoke app authorization for an Snyk Group with install ID.
| 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 |
The app install has been de-authorized.
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.
DELETE /groups/{group_id}/apps/installs/{install_id}
/orgs/{org_id}/apps/creations/{app_id}
Delete an app by its App ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | Org ID |
| app_id | path | optional | App ID |
|
| version | query | optional | The requested version of the endpoint to process the request |
The app has been deleted
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.
DELETE /orgs/{org_id}/apps/creations/{app_id}
/orgs/{org_id}/apps/installs/{install_id}
Revoke app authorization for an Snyk Organization with install ID.
| 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 |
The app install has been revoked.
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.
DELETE /orgs/{org_id}/apps/installs/{install_id}
/self/apps/installs/{install_id}
Revoke access for an app by install ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| install_id | path | optional | Install ID |
The app install has been revoked.
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.
DELETE /self/apps/installs/{install_id}
/self/apps/{app_id}
Revoke access for an app by app id
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| app_id | path | optional | App ID |
The app has been revoked
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.
DELETE /self/apps/{app_id}
/self/apps/{app_id}/sessions/{session_id}
Revoke an active user app session.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| app_id | path | optional | App ID |
|
| session_id | path | required | string | Session ID |
The user app sessions has been revoked.
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.
DELETE /self/apps/{app_id}/sessions/{session_id}
/orgs/{org_id}/collections/{collection_id}
Delete 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 |
| collection_id | path | optional | string | Unique identifier for a collection |
Collection was deleted 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.
DELETE /orgs/{org_id}/collections/{collection_id}
/orgs/{org_id}/collections/{collection_id}/relationships/projects
Remove projects from a collection by specifying an array of either project ids or target ids (for targets, the respective projects will be removed)
| 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
DeleteProjectsFromCollectionRequest
| Property | Type | Required |
|---|---|---|
| data | array | required |
| └ id | string | required |
| └ type | string | required |
successfully removing projects from 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.
DELETE /orgs/{org_id}/collections/{collection_id}/relationships/projects
/custom_base_images/{custombaseimage_id}
Delete a custom base image resource. (the related container project is unaffected)
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | query | optional | The requested version of the endpoint to process the request |
|
| custombaseimage_id | path | optional | string | Unique identifier for custom base image |
Successfully deleted the custom base image
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.
DELETE /custom_base_images/{custombaseimage_id}
/orgs/{org_id}/invites/{invite_id}
Cancel a pending user invitations to an organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The id of the org the user is being invited to |
| invite_id | path | required | string | The id of the pending invite to cancel |
| version | query | optional | The requested version of the endpoint to process the request |
The operation completed successfully with no content
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.
DELETE /orgs/{org_id}/invites/{invite_id}
/orgs/{org_id}/projects/{project_id}
Delete one project in the organization by project ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The ID of the org to which the project belongs to. |
| project_id | path | required | string | The ID of the project. |
| version | query | optional | The requested version of the endpoint to process the request |
The project has been deleted
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.
DELETE /orgs/{org_id}/projects/{project_id}
/groups/{group_id}/service_accounts/{serviceaccount_id}
Permanently delete a group-level service account by its 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 |
Service account was successfully deleted.
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.
DELETE /groups/{group_id}/service_accounts/{serviceaccount_id}
/orgs/{org_id}/service_accounts/{serviceaccount_id}
Delete a service account in an organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The ID of org to which the service account belongs. |
| serviceaccount_id | path | required | string | The ID of the service account. |
| version | query | optional | The requested version of the endpoint to process the request |
The service account has been deleted.
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.
DELETE /orgs/{org_id}/service_accounts/{serviceaccount_id}
/orgs/{org_id}/slack_app/{bot_id}
Remove the given Slack App integration
| 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 |
Slack App integration successfully removed
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.
DELETE /orgs/{org_id}/slack_app/{bot_id}
/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}
Remove 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 |
Slack settings override for the project removed 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.
DELETE /orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}
/orgs/{org_id}/targets/{target_id}
Delete the specified target.
| 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 to delete |
| target_id | path | required | string | The id of the target to delete |
The target is deleted with all projects, if it is found in the specified org.
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.
DELETE /orgs/{org_id}/targets/{target_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 |