Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.snyk.io/rest
No endpoints found for this provider.
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 |