{ "openapi": "3.1.0", "info": { "title": "Laravel Cloud", "version": "0.0.1" }, "servers": [ { "url": "https:\/\/cloud.laravel.com\/api" } ], "tags": [ { "name": "Applications" }, { "name": "Environments" }, { "name": "Domains" }, { "name": "Commands" }, { "name": "Deployments" }, { "name": "Instances" }, { "name": "Background Processes" }, { "name": "Database Clusters" }, { "name": "Databases" }, { "name": "Database Snapshots" }, { "name": "Database Restores" }, { "name": "Object Storage Buckets" }, { "name": "Bucket Keys" }, { "name": "Caches" }, { "name": "WebSocket Clusters" }, { "name": "WebSocket Applications" }, { "name": "Dedicated Clusters" }, { "name": "Usage" }, { "name": "Meta" }, { "name": "Databases (Legacy)" } ], "security": [ { "http": [] } ], "paths": { "\/applications": { "get": { "operationId": "public.applications.index", "description": "Get a list of all applications for the authenticated organization.", "summary": "List applications", "tags": [ "Applications" ], "parameters": [ { "name": "filter[name]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[region]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[slug]", "in": "query", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "organization", "environments", "defaultEnvironment" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `ApplicationResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ApplicationResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/RepositoryResource" }, { "$ref": "#\/components\/schemas\/OrganizationResource" }, { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" } ] } } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.applications.store", "description": "Create a new application.", "summary": "Create application", "tags": [ "Applications" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreateApplicationRequest" } } } }, "responses": { "201": { "description": "`ApplicationResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ApplicationResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/RepositoryResource" }, { "$ref": "#\/components\/schemas\/OrganizationResource" }, { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" } ] } } }, "required": [ "data" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/applications\/{application}": { "get": { "operationId": "public.applications.show", "description": "Get a specific application.", "summary": "Get application", "tags": [ "Applications" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application identifier", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "organization", "environments", "defaultEnvironment" ] } }, "explode": false } ], "responses": { "200": { "description": "`ApplicationResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ApplicationResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/RepositoryResource" }, { "$ref": "#\/components\/schemas\/OrganizationResource" }, { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "patch": { "operationId": "public.applications.update", "description": "Update an application.", "summary": "Update application", "tags": [ "Applications" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateApplicationRequest" } } } }, "responses": { "200": { "description": "`ApplicationResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ApplicationResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/RepositoryResource" }, { "$ref": "#\/components\/schemas\/OrganizationResource" }, { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" } ] } } }, "required": [ "data" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "delete": { "operationId": "public.applications.destroy", "description": "Delete an application and all of its environments.", "summary": "Delete application", "tags": [ "Applications" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application identifier", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/applications\/{application}\/avatar": { "post": { "operationId": "public.applications.avatar.store", "description": "Upload or replace the avatar for an application.", "summary": "Upload application avatar", "tags": [ "Applications" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "type": "object", "properties": { "avatar": { "type": "string", "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 3072 kilobytes." } }, "required": [ "avatar" ] } } } }, "responses": { "200": { "description": "`ApplicationResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ApplicationResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/RepositoryResource" }, { "$ref": "#\/components\/schemas\/OrganizationResource" }, { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" } ] } } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "delete": { "operationId": "public.applications.avatar.destroy", "description": "Remove the avatar from an application.", "summary": "Delete application avatar", "tags": [ "Applications" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application identifier", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/instances\/{instance}\/background-processes": { "get": { "operationId": "public.instances.background-processes.index", "description": "Get a list of all background processes for the given instance.", "summary": "List background processes", "tags": [ "Background Processes" ], "parameters": [ { "name": "instance", "in": "path", "required": true, "description": "The instance identifier", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "instance" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `BackgroundProcessResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BackgroundProcessResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InstanceResource" } } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.instances.background-processes.store", "description": "Create a new background process for an instance.", "summary": "Create background process", "tags": [ "Background Processes" ], "parameters": [ { "name": "instance", "in": "path", "required": true, "description": "The instance identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreateBackgroundProcessRequest" } } } }, "responses": { "201": { "description": "`BackgroundProcessResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/BackgroundProcessResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InstanceResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/background-processes\/{backgroundProcess}": { "get": { "operationId": "public.background-processes.show", "description": "Get the details of a specific background process.", "summary": "Get background process", "tags": [ "Background Processes" ], "parameters": [ { "name": "backgroundProcess", "in": "path", "required": true, "description": "The background process identifier", "schema": { "type": [ "string", "null" ] } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "instance" ] } }, "explode": false } ], "responses": { "200": { "description": "`BackgroundProcessResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/BackgroundProcessResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InstanceResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "patch": { "operationId": "public.background-processes.update", "description": "Update a background process.", "summary": "Update background process", "tags": [ "Background Processes" ], "parameters": [ { "name": "backgroundProcess", "in": "path", "required": true, "description": "The background process identifier", "schema": { "type": [ "string", "null" ] } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateBackgroundProcessRequest" } } } }, "responses": { "200": { "description": "`BackgroundProcessResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/BackgroundProcessResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InstanceResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "public.background-processes.destroy", "description": "Delete a background process.", "summary": "Delete background process", "tags": [ "Background Processes" ], "parameters": [ { "name": "backgroundProcess", "in": "path", "required": true, "description": "The background process identifier", "schema": { "type": [ "string", "null" ] } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/buckets\/{filesystem}\/keys": { "get": { "operationId": "public.buckets.keys.index", "description": "Get a list of all keys for a specific object storage bucket.", "summary": "List object storage keys", "tags": [ "Bucket Keys" ], "parameters": [ { "name": "filesystem", "in": "path", "required": true, "description": "The filesystem identifier", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "filesystem" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `FilesystemKeyResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FilesystemKeyResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FilesystemResource" } } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.buckets.keys.store", "description": "Create a new key for an object storage bucket.", "summary": "Create object storage key", "tags": [ "Bucket Keys" ], "parameters": [ { "name": "filesystem", "in": "path", "required": true, "description": "The filesystem identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreFilesystemKeyRequest" } } } }, "responses": { "201": { "description": "`FilesystemKeyResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/FilesystemKeyResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FilesystemResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/bucket-keys\/{filesystemKey}": { "get": { "operationId": "public.bucket-keys.show", "description": "Get a specific object storage key.", "summary": "Get object storage key", "tags": [ "Bucket Keys" ], "parameters": [ { "name": "filesystemKey", "in": "path", "required": true, "description": "The filesystem key identifier", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "filesystem" ] } }, "explode": false } ], "responses": { "200": { "description": "`FilesystemKeyResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/FilesystemKeyResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FilesystemResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "patch": { "operationId": "public.bucket-keys.update", "description": "Update an object storage key.", "summary": "Update object storage key", "tags": [ "Bucket Keys" ], "parameters": [ { "name": "filesystemKey", "in": "path", "required": true, "description": "The filesystem key identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateFilesystemKeyRequest" } } } }, "responses": { "200": { "description": "`FilesystemKeyResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/FilesystemKeyResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FilesystemResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "public.bucket-keys.destroy", "description": "Delete an object storage key.", "summary": "Delete object storage key", "tags": [ "Bucket Keys" ], "parameters": [ { "name": "filesystemKey", "in": "path", "required": true, "description": "The filesystem key identifier", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/caches\/types": { "get": { "operationId": "public.caches.types", "summary": "List all available cache types with their configuration options", "tags": [ "Caches" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "string" }, "regions": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CloudRegion" } }, "sizes": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "required": [ "value", "label" ] } }, "supports_auto_upgrade": { "type": "boolean" } }, "required": [ "type", "label", "regions", "sizes", "supports_auto_upgrade" ] } } }, "required": [ "data" ] } } } } } } }, "\/caches": { "get": { "operationId": "public.caches.index", "description": "Get a list of all caches for the authenticated organization.", "summary": "List caches", "tags": [ "Caches" ], "parameters": [ { "name": "filter[type]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[region]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[status]", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paginated set of `CacheResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CacheResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EnvironmentResource" } } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.caches.store", "description": "Create a new cache.", "summary": "Create cache", "tags": [ "Caches" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreCacheRequest" } } } }, "responses": { "201": { "description": "`CacheResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/CacheResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EnvironmentResource" } } }, "required": [ "data" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/caches\/{cache}": { "get": { "operationId": "public.caches.show", "description": "Get a specific cache.", "summary": "Get cache", "tags": [ "Caches" ], "parameters": [ { "name": "cache", "in": "path", "required": true, "description": "The cache identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`CacheResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/CacheResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EnvironmentResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "patch": { "operationId": "public.caches.update", "description": "Update a cache.", "summary": "Update cache", "tags": [ "Caches" ], "parameters": [ { "name": "cache", "in": "path", "required": true, "description": "The cache identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateCacheRequest" } } } }, "responses": { "200": { "description": "`CacheResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/CacheResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EnvironmentResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "public.caches.destroy", "description": "Delete a cache.", "summary": "Delete cache", "tags": [ "Caches" ], "parameters": [ { "name": "cache", "in": "path", "required": true, "description": "The cache identifier", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/caches\/{cache}\/metrics": { "get": { "operationId": "public.caches.metrics", "description": "Get metrics for a specific cache.", "summary": "Get cache metrics", "tags": [ "Caches" ], "parameters": [ { "name": "cache", "in": "path", "required": true, "description": "The cache identifier", "schema": { "type": "string" } }, { "name": "period", "in": "query", "schema": { "anyOf": [ { "$ref": "#\/components\/schemas\/MetricPeriod" }, { "type": "null" } ] } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "hits_and_misses": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] }, "throughput": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] }, "size": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "number" } }, "required": [ "x", "y" ] } }, "total": { "type": "number" } }, "required": [ "data", "total" ] }, "bandwidth_usage": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "number" } }, "required": [ "x", "y" ] } }, "total": { "type": "number" } }, "required": [ "data", "total" ] } }, "required": [ "hits_and_misses", "throughput", "size", "bandwidth_usage" ] }, "meta": { "type": "object", "properties": { "period": { "type": "string" }, "available_periods": { "type": "array", "items": { "type": "string" } } }, "required": [ "period", "available_periods" ] } }, "required": [ "data", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/environments\/{environment}\/commands": { "get": { "operationId": "public.environments.commands.index", "description": "Get a list of all commands for the given environment.", "summary": "List commands", "tags": [ "Commands" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } }, { "name": "filter[status]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[command]", "in": "query", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "environment", "deployment", "initiator" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `CommandResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CommandResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" }, { "$ref": "#\/components\/schemas\/UserResource" } ] } } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.environments.commands.store", "description": "Run a command on the given environment.", "summary": "Run command", "tags": [ "Commands" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreateCommandRequest" } } } }, "responses": { "200": { "description": "`CommandResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/CommandResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" }, { "$ref": "#\/components\/schemas\/UserResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/commands\/{command}": { "get": { "operationId": "public.commands.show", "description": "Get the details of a specific command.", "summary": "Get command", "tags": [ "Commands" ], "parameters": [ { "name": "command", "in": "path", "required": true, "description": "The command identifier", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "environment", "deployment", "initiator" ] } }, "explode": false } ], "responses": { "200": { "description": "`CommandResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/CommandResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" }, { "$ref": "#\/components\/schemas\/UserResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/databases\/types": { "get": { "operationId": "public.databases.types", "description": "List all available database types with their configuration schemas.", "summary": "List database types", "tags": [ "Database Clusters" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "string" }, "regions": { "type": "array", "items": { "type": "string" } }, "config_schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "required": { "type": "boolean" }, "nullable": { "type": "boolean" }, "description": { "type": "string" }, "min": { "type": "integer" }, "max": { "type": "integer" }, "enum": { "type": "array", "items": { "type": "string" } }, "example": { "type": "string" } }, "required": [ "name", "type", "required" ] } } }, "required": [ "type", "label", "regions", "config_schema" ] } } }, "required": [ "data" ] } } } } } } }, "\/databases\/clusters": { "get": { "operationId": "public.databases.clusters.index", "description": "Get a list of all database clusters for the authenticated organization. The `schemas` relationship is deprecated.", "summary": "List database clusters", "tags": [ "Database Clusters" ], "parameters": [ { "name": "filter[type]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[region]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[status]", "in": "query", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "schemas", "databases" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `DatabaseResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" } } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.databases.clusters.store", "description": "Create a new database cluster. A default database will also be created and returned on the `databases` relationship. `schemas` is deprecated.", "summary": "Create database cluster", "tags": [ "Database Clusters" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreDatabaseRequest" } } } }, "responses": { "201": { "description": "`DatabaseResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DatabaseResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" } } }, "required": [ "data" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/databases\/clusters\/{database}": { "get": { "operationId": "public.databases.clusters.show", "description": "Get a specific database cluster. The `schemas` relationship is deprecated.", "summary": "Get database cluster", "tags": [ "Database Clusters" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "schemas", "databases" ] } }, "explode": false } ], "responses": { "200": { "description": "`DatabaseResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DatabaseResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "patch": { "operationId": "public.databases.clusters.update", "description": "Update a database cluster.", "summary": "Update database cluster", "tags": [ "Database Clusters" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateDatabaseRequest" } } } }, "responses": { "200": { "description": "`DatabaseResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DatabaseResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "public.databases.clusters.destroy", "description": "Delete a database cluster.", "summary": "Delete database cluster", "tags": [ "Database Clusters" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/databases\/clusters\/{database}\/metrics": { "get": { "operationId": "public.databases.clusters.metrics", "description": "Get metrics for a specific database cluster.", "summary": "Get database cluster metrics", "tags": [ "Database Clusters" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } }, { "name": "period", "in": "query", "schema": { "anyOf": [ { "$ref": "#\/components\/schemas\/MetricPeriod" }, { "type": "null" } ] } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "cpu_usage": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] }, "compute_hours": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] }, "memory_usage": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] }, "writes": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] }, "storage_usage": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] }, "replica_lag": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] } }, "required": [ "cpu_usage", "compute_hours", "memory_usage", "writes", "storage_usage", "replica_lag" ] }, "meta": { "type": "object", "properties": { "period": { "type": "string" }, "available_periods": { "type": "array", "items": { "type": "string" } } }, "required": [ "period", "available_periods" ] } }, "required": [ "data", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/databases\/clusters\/{database}\/restore": { "post": { "operationId": "public.databases.clusters.restore", "description": "Restore a database cluster from a point in time or snapshot. Returns the newly created database.", "summary": "Create a database restore", "tags": [ "Database Restores" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreDatabaseRestoreRequest" } } } }, "responses": { "201": { "description": "`DatabaseResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DatabaseResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/databases\/clusters\/{database}\/snapshots": { "get": { "operationId": "public.databases.clusters.snapshots.index", "description": "Get a list of all snapshots for a specific database cluster.", "summary": "List database snapshots", "tags": [ "Database Snapshots" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "database" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `DatabaseSnapshotResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseSnapshotResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseResource" } } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.databases.clusters.snapshots.store", "description": "Create a new manual snapshot for a database cluster.", "summary": "Create a database snapshot", "tags": [ "Database Snapshots" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreDatabaseSnapshotRequest" } } } }, "responses": { "201": { "description": "`DatabaseSnapshotResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DatabaseSnapshotResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/database-snapshots\/{databaseSnapshot}": { "get": { "operationId": "public.database-snapshots.show", "description": "Get a specific database snapshot.", "summary": "Get a database snapshot", "tags": [ "Database Snapshots" ], "parameters": [ { "name": "databaseSnapshot", "in": "path", "required": true, "description": "The database snapshot identifier", "schema": { "type": [ "string", "null" ] } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "database" ] } }, "explode": false } ], "responses": { "200": { "description": "`DatabaseSnapshotResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DatabaseSnapshotResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "delete": { "operationId": "public.database-snapshots.destroy", "summary": "Delete a database snapshot", "tags": [ "Database Snapshots" ], "parameters": [ { "name": "databaseSnapshot", "in": "path", "required": true, "description": "The database snapshot identifier", "schema": { "type": [ "string", "null" ] } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/databases\/clusters\/{database}\/databases": { "get": { "operationId": "public.databases.clusters.databases.index", "description": "Get a list of all databases for a specific database cluster.", "summary": "List databases", "tags": [ "Databases" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "database", "environments" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `DatabaseSchemaResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/DatabaseResource" }, { "$ref": "#\/components\/schemas\/EnvironmentResource" } ] } } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.databases.clusters.databases.store", "description": "Create a new database in a database cluster.", "summary": "Create a database", "tags": [ "Databases" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreDatabaseSchemaRequest" } } } }, "responses": { "201": { "description": "`DatabaseSchemaResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/DatabaseResource" }, { "$ref": "#\/components\/schemas\/EnvironmentResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/databases\/clusters\/{database}\/databases\/{schema}": { "get": { "operationId": "public.databases.clusters.databases.show", "description": "Get a specific database.", "summary": "Get a database", "tags": [ "Databases" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } }, { "name": "schema", "in": "path", "required": true, "description": "The schema identifier", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "database", "environments" ] } }, "explode": false } ], "responses": { "200": { "description": "`DatabaseSchemaResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/DatabaseResource" }, { "$ref": "#\/components\/schemas\/EnvironmentResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "delete": { "operationId": "public.databases.clusters.databases.destroy", "description": "Delete a database from a database cluster.", "summary": "Delete a database", "tags": [ "Databases" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } }, { "name": "schema", "in": "path", "required": true, "description": "The schema identifier", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/databases": { "get": { "operationId": "public.databases.deprecated.index", "description": "Use GET \/databases\/clusters instead.", "summary": "List databases", "deprecated": true, "tags": [ "Databases (Legacy)" ], "parameters": [ { "name": "filter[type]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[region]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[status]", "in": "query", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "schemas" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `DatabaseResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" } } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.databases.deprecated.store", "description": "Use POST \/databases\/clusters instead.", "summary": "Create database", "deprecated": true, "tags": [ "Databases (Legacy)" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreDatabaseRequest" } } } }, "responses": { "201": { "description": "`DatabaseResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DatabaseResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" } } }, "required": [ "data" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/databases\/{database}": { "get": { "operationId": "public.databases.deprecated.show", "description": "Use GET \/databases\/clusters\/{database} instead.", "summary": "Get database", "deprecated": true, "tags": [ "Databases (Legacy)" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "schemas" ] } }, "explode": false } ], "responses": { "200": { "description": "`DatabaseResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DatabaseResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "patch": { "operationId": "public.databases.deprecated.update", "description": "Use PATCH \/databases\/clusters\/{database} instead.", "summary": "Update database", "deprecated": true, "tags": [ "Databases (Legacy)" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateDatabaseRequest" } } } }, "responses": { "200": { "description": "`DatabaseResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DatabaseResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "public.databases.deprecated.destroy", "description": "Use DELETE \/databases\/clusters\/{database} instead.", "summary": "Delete database", "deprecated": true, "tags": [ "Databases (Legacy)" ], "parameters": [ { "name": "database", "in": "path", "required": true, "description": "The database identifier", "schema": { "type": [ "string", "null" ] } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/dedicated-clusters": { "get": { "operationId": "public.dedicated-clusters.index", "description": "Get a list of all dedicated clusters for the authenticated organization.", "summary": "List dedicated clusters", "tags": [ "Dedicated Clusters" ], "parameters": [ { "name": "filter[region]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[type]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[status]", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paginated set of `ClusterResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ClusterResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } } } } }, "\/environments\/{environment}\/deployments": { "get": { "operationId": "public.environments.deployments.index", "description": "Get a list of all deployments for the given environment.", "summary": "List deployments", "tags": [ "Deployments" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } }, { "name": "filter[status]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[branch_name]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[commit_hash]", "in": "query", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "environment", "initiator" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `DeploymentResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DeploymentResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/UserResource" } ] } } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.environments.deployments.store", "description": "Initiate a deployment for the given environment.", "summary": "Initiate deployment", "tags": [ "Deployments" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`DeploymentResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DeploymentResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/UserResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/deployments\/{deployment}": { "get": { "operationId": "public.deployments.show", "description": "Get the details of a specific deployment.", "summary": "Get deployment", "tags": [ "Deployments" ], "parameters": [ { "name": "deployment", "in": "path", "required": true, "description": "The deployment identifier", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "environment", "initiator" ] } }, "explode": false } ], "responses": { "200": { "description": "`DeploymentResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DeploymentResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/UserResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/deployments\/{deployment}\/logs": { "get": { "operationId": "public.deployments.logs", "description": "Get the build and deploy logs for a specific deployment.", "summary": "Get deployment logs", "tags": [ "Deployments" ], "parameters": [ { "name": "deployment", "in": "path", "required": true, "description": "The deployment identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "build": { "type": "object", "properties": { "available": { "type": "boolean" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "step": { "type": "string" }, "status": { "type": "string" }, "description": { "type": "string" }, "output": { "type": "string" }, "duration_ms": { "type": "integer" }, "time": { "type": "string" } }, "required": [ "step", "status", "description" ] } } }, "required": [ "available", "steps" ] }, "deploy": { "type": "object", "properties": { "available": { "type": "boolean" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "step": { "type": "string" }, "status": { "type": "string" }, "description": { "type": "string" }, "output": { "type": "string" }, "duration_ms": { "type": "integer" }, "time": { "type": "string" } }, "required": [ "step", "status", "description" ] } } }, "required": [ "available", "steps" ] } }, "required": [ "build", "deploy" ] }, "meta": { "type": "object", "properties": { "deployment_status": { "type": "string" } }, "required": [ "deployment_status" ] } }, "required": [ "data", "meta" ] } } } }, "422": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "Deployment logs are only available for deployments created within the last year." ] } }, "required": [ "message" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/environments\/{environment}\/domains": { "get": { "operationId": "public.environments.domains.index", "description": "List all domains for the given environment.", "summary": "List domains", "tags": [ "Domains" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } }, { "name": "filter[name]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[hostname_status]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[ssl_status]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[origin_status]", "in": "query", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "environment" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `SimplifiedDomainResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SimplifiedDomainResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EnvironmentResource" } } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.environments.domains.store", "description": "Create a new domain for the given environment. After creating the domain, you'll have to add the required DNS records to your DNS provider. This might be a 2-step process, depending on the verification method used. You can check the required DNS records in the response of this endpoint, and you can verify the domain using the \"verify\" query parameter in the \"Get domain\" endpoint.", "summary": "Create domain", "tags": [ "Domains" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreateDomainRequest" } } } }, "responses": { "200": { "description": "`DomainResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DomainResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EnvironmentResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/domains\/{domain}": { "get": { "operationId": "public.domains.show", "description": "Show a specific domain.", "summary": "Get domain", "tags": [ "Domains" ], "parameters": [ { "name": "domain", "in": "path", "required": true, "description": "The domain identifier", "schema": { "type": [ "string", "null" ] } }, { "name": "verify", "in": "query", "description": "Whether the domain's DNS records should be verified and validated.", "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "environment" ] } }, "explode": false } ], "responses": { "200": { "description": "`DomainResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DomainResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EnvironmentResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "patch": { "operationId": "public.domains.update", "description": "Update a specific domain.", "summary": "Update domain", "tags": [ "Domains" ], "parameters": [ { "name": "domain", "in": "path", "required": true, "description": "The domain identifier", "schema": { "type": [ "string", "null" ] } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateDomainRequest" } } } }, "responses": { "200": { "description": "`DomainResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DomainResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EnvironmentResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "public.domains.destroy", "description": "Delete a specific domain.", "summary": "Delete domain", "tags": [ "Domains" ], "parameters": [ { "name": "domain", "in": "path", "required": true, "description": "The domain identifier", "schema": { "type": [ "string", "null" ] } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/domains\/{domain}\/verify": { "post": { "operationId": "public.domains.verify", "description": "Checks whether the DNS records for a given domain have been properly set up.", "summary": "Verify a domain", "tags": [ "Domains" ], "parameters": [ { "name": "domain", "in": "path", "required": true, "description": "The domain identifier", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "`DomainResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DomainResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EnvironmentResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/applications\/{application}\/environments": { "get": { "operationId": "public.applications.environments.index", "description": "Get a list of all environments for the given application.", "summary": "List environments", "tags": [ "Environments" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application identifier", "schema": { "type": "string" } }, { "name": "filter[name]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[status]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[slug]", "in": "query", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "application", "branch", "deployments", "currentDeployment", "primaryDomain", "instances", "database", "cache", "buckets", "websocketApplication" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `EnvironmentResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EnvironmentResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/ApplicationResource" }, { "$ref": "#\/components\/schemas\/BranchResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" }, { "$ref": "#\/components\/schemas\/DomainResource" }, { "$ref": "#\/components\/schemas\/InstanceResource" }, { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" }, { "$ref": "#\/components\/schemas\/CacheResource" }, { "$ref": "#\/components\/schemas\/FilesystemResource" }, { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" } ] } } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.applications.environments.store", "description": "Create a new environment.", "summary": "Create environment", "tags": [ "Environments" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreateEnvironmentRequest" } } } }, "responses": { "201": { "description": "`EnvironmentResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/EnvironmentResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/ApplicationResource" }, { "$ref": "#\/components\/schemas\/BranchResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" }, { "$ref": "#\/components\/schemas\/DomainResource" }, { "$ref": "#\/components\/schemas\/InstanceResource" }, { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" }, { "$ref": "#\/components\/schemas\/CacheResource" }, { "$ref": "#\/components\/schemas\/FilesystemResource" }, { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/environments\/{environment}\/logs": { "get": { "operationId": "public.environments.logs.index", "description": "Get a list of logs for the given environment.", "summary": "List environment logs", "tags": [ "Environments" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "type", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "all", "application", "access", null ] } }, { "name": "case_sensitive", "in": "query", "schema": { "type": [ "boolean", "null" ] } }, { "name": "whole_word", "in": "query", "schema": { "type": [ "boolean", "null" ] } }, { "name": "instances[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "cursor", "in": "query", "description": "Pagination cursor from a previous response. Pass this to fetch the next page of logs.", "schema": { "type": [ "string", "null" ] } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Array of `NormalizedLogResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NormalizedLogResource" } }, "meta": { "type": "object", "properties": { "cursor": { "type": "string" }, "type": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "cursor", "type", "from", "to" ] } }, "required": [ "data", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/environments\/{environment}": { "get": { "operationId": "public.environments.show", "description": "Get a specific environment.", "summary": "Get environment", "tags": [ "Environments" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "application", "branch", "deployments", "currentDeployment", "primaryDomain", "instances", "database", "cache", "buckets", "websocketApplication" ] } }, "explode": false } ], "responses": { "200": { "description": "`EnvironmentResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/EnvironmentResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/ApplicationResource" }, { "$ref": "#\/components\/schemas\/BranchResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" }, { "$ref": "#\/components\/schemas\/DomainResource" }, { "$ref": "#\/components\/schemas\/InstanceResource" }, { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" }, { "$ref": "#\/components\/schemas\/CacheResource" }, { "$ref": "#\/components\/schemas\/FilesystemResource" }, { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "patch": { "operationId": "public.environments.update", "description": "Update an environment.", "summary": "Update environment", "tags": [ "Environments" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateEnvironmentRequest" } } } }, "responses": { "200": { "description": "`EnvironmentResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/EnvironmentResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/ApplicationResource" }, { "$ref": "#\/components\/schemas\/BranchResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" }, { "$ref": "#\/components\/schemas\/DomainResource" }, { "$ref": "#\/components\/schemas\/InstanceResource" }, { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" }, { "$ref": "#\/components\/schemas\/CacheResource" }, { "$ref": "#\/components\/schemas\/FilesystemResource" }, { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "public.environments.destroy", "description": "Delete an environment.", "summary": "Delete environment", "tags": [ "Environments" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/environments\/{environment}\/start": { "post": { "operationId": "public.environments.start", "description": "Start an environment and trigger a deployment.", "summary": "Start environment", "tags": [ "Environments" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StartEnvironmentRequest" } } } }, "responses": { "200": { "description": "`DeploymentResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DeploymentResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/UserResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/environments\/{environment}\/stop": { "post": { "operationId": "public.environments.stop", "description": "Stop an environment and cancel any in-progress deployment.", "summary": "Stop environment", "tags": [ "Environments" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`EnvironmentResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/EnvironmentResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/ApplicationResource" }, { "$ref": "#\/components\/schemas\/BranchResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" }, { "$ref": "#\/components\/schemas\/DomainResource" }, { "$ref": "#\/components\/schemas\/InstanceResource" }, { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" }, { "$ref": "#\/components\/schemas\/CacheResource" }, { "$ref": "#\/components\/schemas\/FilesystemResource" }, { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/environments\/{environment}\/purge-edge-cache": { "post": { "operationId": "public.environments.purge-edge-cache", "description": "Purge the edge cache for all domains associated with the environment.", "summary": "Purge edge cache", "tags": [ "Environments" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`EnvironmentResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/EnvironmentResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/ApplicationResource" }, { "$ref": "#\/components\/schemas\/BranchResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" }, { "$ref": "#\/components\/schemas\/DomainResource" }, { "$ref": "#\/components\/schemas\/InstanceResource" }, { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" }, { "$ref": "#\/components\/schemas\/CacheResource" }, { "$ref": "#\/components\/schemas\/FilesystemResource" }, { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/environments\/{environment}\/variables": { "post": { "operationId": "public.environments.variables.store", "description": "Add environment variables to an environment.", "summary": "Add environment variables", "tags": [ "Environments" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreEnvironmentVariablesRequest" } } } }, "responses": { "200": { "description": "`EnvironmentResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/EnvironmentResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/ApplicationResource" }, { "$ref": "#\/components\/schemas\/BranchResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" }, { "$ref": "#\/components\/schemas\/DomainResource" }, { "$ref": "#\/components\/schemas\/InstanceResource" }, { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" }, { "$ref": "#\/components\/schemas\/CacheResource" }, { "$ref": "#\/components\/schemas\/FilesystemResource" }, { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/environments\/{environment}\/variables\/delete": { "post": { "operationId": "public.environments.variables.destroy", "description": "Remove specific environment variables by key name. This operation is atomic: if any of the specified keys do not exist, no variables will be deleted and an error will be returned indicating which keys were missing.", "summary": "Delete environment variables", "tags": [ "Environments" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeleteEnvironmentVariablesRequest" } } } }, "responses": { "200": { "description": "`EnvironmentResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/EnvironmentResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/ApplicationResource" }, { "$ref": "#\/components\/schemas\/BranchResource" }, { "$ref": "#\/components\/schemas\/DeploymentResource" }, { "$ref": "#\/components\/schemas\/DomainResource" }, { "$ref": "#\/components\/schemas\/InstanceResource" }, { "$ref": "#\/components\/schemas\/DatabaseSchemaResource" }, { "$ref": "#\/components\/schemas\/CacheResource" }, { "$ref": "#\/components\/schemas\/FilesystemResource" }, { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/environments\/{environment}\/metrics": { "get": { "operationId": "public.environments.metrics", "description": "Get metrics for a specific environment.", "summary": "Get environment metrics", "tags": [ "Environments" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } }, { "name": "period", "in": "query", "schema": { "anyOf": [ { "$ref": "#\/components\/schemas\/MetricPeriod" }, { "type": "null" } ] } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "cpu_usage": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] }, "memory_usage": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] }, "http_response_count": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] }, "replica_count": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] }, "web_workers_count": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] } }, "required": [ "cpu_usage", "memory_usage", "http_response_count", "replica_count", "web_workers_count" ] }, "meta": { "type": "object", "properties": { "period": { "type": "string" }, "available_periods": { "type": "array", "items": { "type": "string" } } }, "required": [ "period", "available_periods" ] } }, "required": [ "data", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/environments\/{environment}\/instances": { "get": { "operationId": "public.environments.instances.index", "description": "Get a list of all instances for the given environment.", "summary": "List instances", "tags": [ "Instances" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } }, { "name": "filter[name]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[type]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[size]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[scaling_type]", "in": "query", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "environment", "backgroundProcesses" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `InstanceResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InstanceResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/BackgroundProcessResource" } ] } } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.environments.instances.store", "description": "Create a new instance for an environment.", "summary": "Create instance", "tags": [ "Instances" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "description": "The environment identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreateInstanceRequest" } } } }, "responses": { "201": { "description": "`InstanceResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/InstanceResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/BackgroundProcessResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/instances\/sizes": { "get": { "operationId": "public.instances.sizes", "description": "List all available instance sizes grouped by category.", "summary": "List instance sizes", "tags": [ "Instances" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "general": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "cpu_type": { "type": "string" }, "compute_class": { "type": "string" }, "cpu_count": { "type": "integer" }, "memory_mib": { "type": "integer" } }, "required": [ "name", "label", "description", "cpu_type", "compute_class", "cpu_count", "memory_mib" ] } }, "managed_queue": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "cpu_type": { "type": "string" }, "compute_class": { "type": "string" }, "cpu_count": { "type": "number" }, "memory_mib": { "type": "integer" } }, "required": [ "name", "label", "description", "cpu_type", "compute_class", "cpu_count", "memory_mib" ] } } }, "required": [ "general", "managed_queue" ] } }, "required": [ "data" ] } } } } } } }, "\/instances\/{instance}": { "get": { "operationId": "public.instances.show", "description": "Get the details of a specific instance.", "summary": "Get instance", "tags": [ "Instances" ], "parameters": [ { "name": "instance", "in": "path", "required": true, "description": "The instance identifier", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "environment", "backgroundProcesses" ] } }, "explode": false } ], "responses": { "200": { "description": "`InstanceResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/InstanceResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/BackgroundProcessResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "patch": { "operationId": "public.instances.update", "description": "Update an instance.", "summary": "Update instance", "tags": [ "Instances" ], "parameters": [ { "name": "instance", "in": "path", "required": true, "description": "The instance identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateInstanceRequest" } } } }, "responses": { "200": { "description": "`InstanceResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/InstanceResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/BackgroundProcessResource" } ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "public.instances.destroy", "description": "Delete an instance.", "summary": "Delete instance", "tags": [ "Instances" ], "parameters": [ { "name": "instance", "in": "path", "required": true, "description": "The instance identifier", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/instances\/{instance}\/pause": { "post": { "operationId": "public.instances.pause", "description": "Stop dispatching jobs to the queue's workers; queued messages are retained until it is resumed.", "summary": "Pause a managed queue", "tags": [ "Instances" ], "parameters": [ { "name": "instance", "in": "path", "required": true, "description": "The instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`InstanceResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/InstanceResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/BackgroundProcessResource" } ] } } }, "required": [ "data" ] } }, "application\/json": { "schema": { "type": "string", "examples": [ { "data": { "type": "instances", "id": "inst-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "attributes": { "name": "orders", "type": "managed_queue", "queue_status": "available", "paused": true, "is_default": false, "visibility_timeout": 60, "polling_interval": 20 } } } ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/instances\/{instance}\/resume": { "post": { "operationId": "public.instances.resume", "description": "Resume dispatching jobs to the queue's workers after it was paused.", "summary": "Resume a managed queue", "tags": [ "Instances" ], "parameters": [ { "name": "instance", "in": "path", "required": true, "description": "The instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`InstanceResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/InstanceResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/BackgroundProcessResource" } ] } } }, "required": [ "data" ] } }, "application\/json": { "schema": { "type": "string", "examples": [ { "data": { "type": "instances", "id": "inst-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "attributes": { "name": "orders", "type": "managed_queue", "queue_status": "available", "paused": false, "is_default": false, "visibility_timeout": 60, "polling_interval": 20 } } } ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/instances\/{instance}\/purge": { "post": { "operationId": "public.instances.purge", "description": "Permanently delete all messages currently in the queue. This cannot be undone.", "summary": "Purge a managed queue", "tags": [ "Instances" ], "parameters": [ { "name": "instance", "in": "path", "required": true, "description": "The instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`InstanceResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/InstanceResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/BackgroundProcessResource" } ] } } }, "required": [ "data" ] } }, "application\/json": { "schema": { "type": "string", "examples": [ { "data": { "type": "instances", "id": "inst-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "attributes": { "name": "orders", "type": "managed_queue", "queue_status": "available", "paused": false, "is_default": false, "visibility_timeout": 60, "polling_interval": 20 } } } ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/instances\/{instance}\/default": { "post": { "operationId": "public.instances.default", "description": "Make this queue the environment's default, used when a job does not specify a queue.", "summary": "Set the default managed queue", "tags": [ "Instances" ], "parameters": [ { "name": "instance", "in": "path", "required": true, "description": "The instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`InstanceResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/InstanceResource" }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResource" }, { "$ref": "#\/components\/schemas\/BackgroundProcessResource" } ] } } }, "required": [ "data" ] } }, "application\/json": { "schema": { "type": "string", "examples": [ { "data": { "type": "instances", "id": "inst-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "attributes": { "name": "orders", "type": "managed_queue", "queue_status": "available", "paused": false, "is_default": true, "visibility_timeout": 60, "polling_interval": 20 } } } ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/instances\/{instance}\/failed-jobs": { "get": { "operationId": "public.instances.failed-jobs.index", "description": "Get a list of the jobs that have failed on the given managed queue.", "summary": "List managed queue failed jobs", "tags": [ "Instances" ], "parameters": [ { "name": "instance", "in": "path", "required": true, "description": "The instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paginated set of `ManagedQueueFailedJobResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ManagedQueueFailedJobResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/instances\/{instance}\/failed-jobs\/{jobId}\/retry": { "post": { "operationId": "public.instances.failed-jobs.retry", "description": "Re-queue a failed job so it is processed again.", "summary": "Retry a managed queue failed job", "tags": [ "Instances" ], "parameters": [ { "name": "instance", "in": "path", "required": true, "description": "The instance identifier", "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "required": true, "description": "The identifier of the failed job.", "schema": { "type": "string" } } ], "responses": { "202": { "description": "The job is being retried.", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "The job is being retried." } }, "required": [ "message" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/instances\/{instance}\/failed-jobs\/{jobId}": { "delete": { "operationId": "public.instances.failed-jobs.destroy", "description": "Permanently remove a failed job from the given managed queue.", "summary": "Delete a managed queue failed job", "tags": [ "Instances" ], "parameters": [ { "name": "instance", "in": "path", "required": true, "description": "The instance identifier", "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "required": true, "description": "The identifier of the failed job.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The failed job was deleted.", "content": { "application\/json": { "schema": { "type": "string" } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/meta\/organization": { "get": { "operationId": "public.meta.organization", "description": "Get details about the currently authenticated organization.", "summary": "Get organization", "tags": [ "Meta" ], "responses": { "200": { "description": "`OrganizationResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/OrganizationResource" } }, "required": [ "data" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } } } } }, "\/meta\/regions": { "get": { "operationId": "public.meta.regions", "description": "List all available cloud regions.", "summary": "List regions", "tags": [ "Meta" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "region": { "$ref": "#\/components\/schemas\/CloudRegion" }, "label": { "type": "string" }, "flag": { "type": "string" } }, "required": [ "region", "label", "flag" ] } } }, "required": [ "data" ] } } } } } } }, "\/buckets": { "get": { "operationId": "public.buckets.index", "description": "Get a list of all object storage buckets for the authenticated organization.", "summary": "List object storage buckets", "tags": [ "Object Storage Buckets" ], "parameters": [ { "name": "filter[type]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[status]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[visibility]", "in": "query", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "keys" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `FilesystemResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FilesystemResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FilesystemKeyResource" } } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.buckets.store", "description": "Create a new object storage bucket with an initial key.", "summary": "Create object storage bucket", "tags": [ "Object Storage Buckets" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreFilesystemRequest" } } } }, "responses": { "201": { "description": "`FilesystemResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/FilesystemResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FilesystemKeyResource" } } }, "required": [ "data" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/buckets\/{filesystem}": { "get": { "operationId": "public.buckets.show", "description": "Get a specific object storage bucket.", "summary": "Get object storage bucket", "tags": [ "Object Storage Buckets" ], "parameters": [ { "name": "filesystem", "in": "path", "required": true, "description": "The filesystem identifier", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "keys" ] } }, "explode": false } ], "responses": { "200": { "description": "`FilesystemResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/FilesystemResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FilesystemKeyResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "patch": { "operationId": "public.buckets.update", "description": "Update an object storage bucket.", "summary": "Update object storage bucket", "tags": [ "Object Storage Buckets" ], "parameters": [ { "name": "filesystem", "in": "path", "required": true, "description": "The filesystem identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateFilesystemRequest" } } } }, "responses": { "200": { "description": "`FilesystemResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/FilesystemResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FilesystemKeyResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "public.buckets.destroy", "description": "Delete an object storage bucket.", "summary": "Delete object storage bucket", "tags": [ "Object Storage Buckets" ], "parameters": [ { "name": "filesystem", "in": "path", "required": true, "description": "The filesystem identifier", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/usage": { "get": { "operationId": "public.usage", "description": "Get billing and usage data for the authenticated organization.", "summary": "Get usage", "tags": [ "Usage" ], "parameters": [ { "name": "period", "in": "query", "description": "The billing period offset. 0 returns the current billing period, 1 returns the previous period, and so on. Periods are not necessarily month-long \u2014 they match your billing cycle. Must be between 0 and 3.", "schema": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 3 }, "example": 0 }, { "name": "environment", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "current_spend_cents": { "type": "integer" }, "bandwidth": { "type": [ "object", "null" ], "properties": { "cost_cents": { "type": "integer" }, "usage_percentage": { "type": "integer" }, "allowance_bytes": { "type": "integer" } }, "required": [ "cost_cents", "usage_percentage", "allowance_bytes" ] }, "credits": { "type": [ "object", "null" ], "properties": { "used_cents": { "type": "integer" }, "total_cents": { "type": "integer" } }, "required": [ "used_cents", "total_cents" ] }, "alert": { "type": [ "object", "null" ], "properties": { "threshold_cents": { "type": "integer" }, "remaining_percentage": { "type": "integer" } }, "required": [ "threshold_cents", "remaining_percentage" ] } }, "required": [ "current_spend_cents", "bandwidth", "credits", "alert" ] }, "resources": { "type": "object", "properties": { "total_cost_cents": { "type": "integer" }, "databases": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "caches": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "buckets": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "websockets": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "total_cost_cents", "databases", "caches", "buckets", "websockets" ] }, "addons": { "type": "object", "properties": { "total_cost_cents": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "total_cents": { "type": "integer" } }, "required": [ "name", "total_cents" ] } } }, "required": [ "total_cost_cents", "items" ] }, "application_totals": { "type": "object", "properties": { "total_cost_cents": { "type": "integer" }, "application_count": { "type": "integer" }, "applications": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "total_cost_cents", "application_count", "applications" ] }, "environment_usage": { "type": [ "object", "null" ], "properties": { "total_cost_cents": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "total_cost_cents", "items" ] }, "private_cloud": { "type": [ "object", "null" ], "properties": { "total_cost_cents": { "type": "integer" }, "sections": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "instances": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } } }, "required": [ "total_cost_cents", "sections", "instances" ] } }, "required": [ "summary", "resources", "addons", "application_totals", "environment_usage", "private_cloud" ] }, "meta": { "type": "object", "properties": { "currency": { "type": "string" }, "period": { "type": "integer" }, "available_periods": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": [ "string", "null" ] }, "to": { "type": [ "string", "null" ] } }, "required": [ "from", "to" ] } }, "last_updated_at": { "type": "string" } }, "required": [ "currency", "period", "available_periods", "last_updated_at" ] } }, "required": [ "data", "meta" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/websocket-servers\/{websocketServer}\/applications": { "get": { "operationId": "public.websocket-servers.applications.index", "description": "Get a list of all applications for a specific WebSocket cluster.", "summary": "List WebSocket applications", "tags": [ "WebSocket Applications" ], "parameters": [ { "name": "websocketServer", "in": "path", "required": true, "description": "The websocket server identifier", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "server" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `WebsocketApplicationResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebsocketServerResource" } } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.websocket-servers.applications.store", "description": "Create a new application for a WebSocket cluster.", "summary": "Create WebSocket application", "tags": [ "WebSocket Applications" ], "parameters": [ { "name": "websocketServer", "in": "path", "required": true, "description": "The websocket server identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreWebsocketApplicationRequest" } } } }, "responses": { "201": { "description": "`WebsocketApplicationResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebsocketServerResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/websocket-applications\/{websocketApplication}": { "get": { "operationId": "public.websocket-applications.show", "description": "Get a specific WebSocket application including credentials.", "summary": "Get WebSocket application", "tags": [ "WebSocket Applications" ], "parameters": [ { "name": "websocketApplication", "in": "path", "required": true, "description": "The websocket application identifier", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "server" ] } }, "explode": false } ], "responses": { "200": { "description": "`WebsocketApplicationResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebsocketServerResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "patch": { "operationId": "public.websocket-applications.update", "description": "Update a WebSocket application.", "summary": "Update WebSocket application", "tags": [ "WebSocket Applications" ], "parameters": [ { "name": "websocketApplication", "in": "path", "required": true, "description": "The websocket application identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateWebsocketApplicationRequest" } } } }, "responses": { "200": { "description": "`WebsocketApplicationResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebsocketServerResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "public.websocket-applications.destroy", "description": "Delete a WebSocket application.", "summary": "Delete WebSocket application", "tags": [ "WebSocket Applications" ], "parameters": [ { "name": "websocketApplication", "in": "path", "required": true, "description": "The websocket application identifier", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/websocket-applications\/{websocketApplication}\/metrics": { "get": { "operationId": "public.websocket-applications.metrics", "description": "Get metrics for a specific WebSocket application.", "summary": "Get WebSocket application metrics", "tags": [ "WebSocket Applications" ], "parameters": [ { "name": "websocketApplication", "in": "path", "required": true, "description": "The websocket application identifier", "schema": { "type": "string" } }, { "name": "period", "in": "query", "schema": { "anyOf": [ { "$ref": "#\/components\/schemas\/MetricPeriod" }, { "type": "null" } ] } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "connection_count": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] }, "message_rate": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] } }, "required": [ "connection_count", "message_rate" ] }, "meta": { "type": "object", "properties": { "period": { "type": "string" }, "available_periods": { "type": "array", "items": { "type": "string" } } }, "required": [ "period", "available_periods" ] } }, "required": [ "data", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/websocket-servers": { "get": { "operationId": "public.websocket-servers.index", "description": "Get a list of all WebSocket clusters for the authenticated organization.", "summary": "List WebSocket clusters", "tags": [ "WebSocket Clusters" ], "parameters": [ { "name": "filter[type]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[region]", "in": "query", "schema": { "type": "string" } }, { "name": "filter[status]", "in": "query", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "applications" ] } }, "explode": false } ], "responses": { "200": { "description": "Paginated set of `WebsocketServerResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebsocketServerResource" } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" } } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "public.websocket-servers.store", "description": "Create a new WebSocket cluster with a default application.", "summary": "Create WebSocket cluster", "tags": [ "WebSocket Clusters" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreWebsocketServerRequest" } } } }, "responses": { "201": { "description": "`WebsocketServerResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WebsocketServerResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" } } }, "required": [ "data" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/websocket-servers\/{websocketServer}": { "get": { "operationId": "public.websocket-servers.show", "description": "Get a specific WebSocket cluster.", "summary": "Get WebSocket cluster", "tags": [ "WebSocket Clusters" ], "parameters": [ { "name": "websocketServer", "in": "path", "required": true, "description": "The websocket server identifier", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "applications" ] } }, "explode": false } ], "responses": { "200": { "description": "`WebsocketServerResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WebsocketServerResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "patch": { "operationId": "public.websocket-servers.update", "description": "Update a WebSocket cluster.", "summary": "Update WebSocket cluster", "tags": [ "WebSocket Clusters" ], "parameters": [ { "name": "websocketServer", "in": "path", "required": true, "description": "The websocket server identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateWebsocketServerRequest" } } } }, "responses": { "200": { "description": "`WebsocketServerResource`", "content": { "application\/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WebsocketServerResource" }, "included": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebsocketApplicationResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "public.websocket-servers.destroy", "description": "Delete a WebSocket cluster and all its applications.", "summary": "Delete WebSocket cluster", "tags": [ "WebSocket Clusters" ], "parameters": [ { "name": "websocketServer", "in": "path", "required": true, "description": "The websocket server identifier", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/websocket-servers\/{websocketServer}\/metrics": { "get": { "operationId": "public.websocket-servers.metrics", "description": "Get metrics for a specific WebSocket cluster.", "summary": "Get WebSocket cluster metrics", "tags": [ "WebSocket Clusters" ], "parameters": [ { "name": "websocketServer", "in": "path", "required": true, "description": "The websocket server identifier", "schema": { "type": "string" } }, { "name": "period", "in": "query", "schema": { "anyOf": [ { "$ref": "#\/components\/schemas\/MetricPeriod" }, { "type": "null" } ] } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "connection_count": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] }, "message_rate": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } }, "average": { "type": "array", "items": { "type": "number" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "string" }, "y": { "type": "array", "items": { "type": "number" } } }, "required": [ "x", "y" ] } } }, "required": [ "labels", "average", "data" ] } }, "required": [ "connection_count", "message_rate" ] }, "meta": { "type": "object", "properties": { "period": { "type": "string" }, "available_periods": { "type": "array", "items": { "type": "string" } } }, "required": [ "period", "available_periods" ] } }, "required": [ "data", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } } }, "components": { "securitySchemes": { "http": { "type": "http", "description": "The Bearer Token generated on the Cloud UI.", "scheme": "bearer", "bearerFormat": "bearer" } }, "schemas": { "ApplicationResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "applications" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" }, "region": { "$ref": "#\/components\/schemas\/CloudRegion" }, "root_directory": { "type": [ "string", "null" ] }, "slack_channel": { "type": [ "string", "null" ] }, "avatar_url": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "repository": { "type": [ "object", "null" ], "properties": { "full_name": { "type": "string" }, "default_branch": { "type": "string" } }, "required": [ "full_name", "default_branch" ] } }, "required": [ "name", "slug", "region", "root_directory", "slack_channel", "avatar_url", "created_at", "repository" ] }, "relationships": { "type": "object", "properties": { "repository": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/RepositoryResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] }, "organization": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/OrganizationResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] }, "environments": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EnvironmentResourceIdentifier" } } }, "required": [ "data" ] }, "deployments": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DeploymentResourceIdentifier" } } }, "required": [ "data" ] }, "defaultEnvironment": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] } } } }, "required": [ "id", "type" ], "title": "ApplicationResource" }, "ApplicationResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "applications" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "ApplicationResourceIdentifier" }, "BackgroundProcessResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "background_processes" ] }, "attributes": { "type": "object", "properties": { "type": { "$ref": "#\/components\/schemas\/DaemonType" }, "processes": { "type": "integer" }, "command": { "type": "string" }, "config": { "type": "array", "items": {} }, "strategy_type": { "$ref": "#\/components\/schemas\/DaemonStrategyType" }, "strategy_threshold": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "type", "processes", "command", "config", "strategy_type", "strategy_threshold", "created_at" ] }, "relationships": { "type": "object", "properties": { "instance": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/InstanceResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] } } } }, "required": [ "id", "type" ], "title": "BackgroundProcessResource" }, "BackgroundProcessResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "background_processes" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "BackgroundProcessResourceIdentifier" }, "BotControlCategory": { "type": "string", "enum": [ "academic_research", "accessibility", "advertising_and_marketing", "aggregator", "ai_assistant", "ai_crawler", "ai_search", "feed_fetcher", "monitoring_and_analytics", "page_preview", "search_engine_crawler", "search_engine_optimization", "security", "social_media_marketing", "webhooks", "other" ], "title": "BotControlCategory" }, "BranchResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "branches" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "repository": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/RepositoryResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] } } } }, "required": [ "id", "type" ], "title": "BranchResource" }, "BranchResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "branches" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "BranchResourceIdentifier" }, "CacheEvictionPolicy": { "type": "string", "enum": [ "allkeys-lru", "noeviction", "volatile-lru", "allkeys-random", "volatile-random", "volatile-ttl", "allkeys-lfu", "volatile-lfu" ], "title": "CacheEvictionPolicy" }, "CacheResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "caches" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#\/components\/schemas\/CacheType" }, "status": { "$ref": "#\/components\/schemas\/CacheStatus" }, "region": { "$ref": "#\/components\/schemas\/CloudRegion" }, "size": { "$ref": "#\/components\/schemas\/CacheSize" }, "auto_upgrade_enabled": { "type": "boolean" }, "is_public": { "type": "boolean" }, "uses_hibernation": { "type": "boolean" }, "hibernation_timeout": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "connection": { "type": "object", "properties": { "hostname": { "type": [ "string", "null" ] }, "port": { "type": [ "integer", "null" ] }, "protocol": { "type": "string", "enum": [ "redis", "fake" ] }, "": { "anyOf": [ { "type": "object", "properties": { "username": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] } }, "required": [ "username", "password" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "hostname", "port", "protocol", null ] } }, "required": [ "name", "type", "status", "region", "size", "auto_upgrade_enabled", "is_public", "uses_hibernation", "hibernation_timeout", "created_at", "connection" ] }, "relationships": { "type": "object", "properties": { "environments": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EnvironmentResourceIdentifier" } } }, "required": [ "data" ] } } } }, "required": [ "id", "type" ], "title": "CacheResource" }, "CacheResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "caches" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "CacheResourceIdentifier" }, "CacheSize": { "type": "string", "enum": [ "250mb", "1gb", "2.5gb", "5gb", "12gb", "50gb", "100gb", "500gb", "valkey-flex-250mb", "valkey-flex-1gb", "valkey-flex-2.5gb", "valkey-pro.250mb", "valkey-pro.1gb", "valkey-pro.2.5gb", "valkey-pro.5gb", "valkey-pro.12gb", "valkey-pro.25gb", "valkey-pro.50gb", "elasticache.cache.r7g.large", "elasticache.cache.r7g.xlarge", "elasticache.cache.r7g.2xlarge", "elasticache.cache.r7g.4xlarge", "elasticache.cache.r7g.8xlarge", "elasticache.cache.r7g.12xlarge", "elasticache.cache.r7g.16xlarge", "elasticache.cache.c7gn.large", "elasticache.cache.c7gn.xlarge", "elasticache.cache.c7gn.2xlarge", "elasticache.cache.c7gn.4xlarge", "elasticache.cache.c7gn.8xlarge", "elasticache.cache.c7gn.12xlarge", "elasticache.cache.c7gn.16xlarge" ], "title": "CacheSize" }, "CacheStatus": { "type": "string", "enum": [ "creating", "updating", "available", "stopped", "deleting", "deleted", "unknown" ], "title": "CacheStatus" }, "CacheStrategy": { "type": "string", "enum": [ "default", "bypass" ], "title": "CacheStrategy" }, "CacheType": { "type": "string", "enum": [ "upstash_redis", "laravel_valkey", "aws_elasticache_redis", "aws_elasticache_valkey" ], "title": "CacheType" }, "CloudRegion": { "type": "string", "enum": [ "us-east-2", "us-east-1", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "me-central-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1" ], "title": "CloudRegion" }, "ClusterResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "clusters" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "region": { "$ref": "#\/components\/schemas\/CloudRegion" }, "type": { "$ref": "#\/components\/schemas\/ClusterType" }, "tenancy_type": { "$ref": "#\/components\/schemas\/TenancyType" }, "status": { "$ref": "#\/components\/schemas\/ClusterStatus" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "name", "region", "type", "tenancy_type", "status", "created_at" ] } }, "required": [ "id", "type" ], "title": "ClusterResource" }, "ClusterStatus": { "type": "string", "enum": [ "draft", "active", "maintenance", "inactive" ], "title": "ClusterStatus" }, "ClusterType": { "type": "string", "description": "When implementing a new cluster type, make sure to: - Adjust the different is{...} methods - Adjust the needsItsCNAMERecordsSynced method - Check if Zone@toSyncClusterVanityDomainTo() needs to be adjusted\n", "enum": [ "applications", "mysql-databases", "rds-databases", "redis-caches", "elasticache-clusters", "reverb-websocket-servers" ], "title": "ClusterType" }, "CommandResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "commands" ] }, "attributes": { "type": "object", "properties": { "command": { "type": "string" }, "output": { "type": [ "string", "null" ] }, "status": { "$ref": "#\/components\/schemas\/CommandStatus" }, "exit_code": { "anyOf": [ { "$ref": "#\/components\/schemas\/ExitCode" }, { "type": "null" } ] }, "failure_reason": { "type": [ "string", "null" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "finished_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "command", "output", "status", "exit_code", "failure_reason", "started_at", "finished_at", "created_at" ] }, "relationships": { "type": "object", "properties": { "environment": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] }, "deployment": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/DeploymentResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] }, "initiator": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/UserResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] } } }, "links": { "type": "object", "properties": { "self": { "$ref": "#\/components\/schemas\/Link" } }, "required": [ "self" ] } }, "required": [ "id", "type", "links" ], "title": "CommandResource" }, "CommandStatus": { "type": "string", "enum": [ "pending", "command.created", "command.running", "command.failure", "command.success" ], "title": "CommandStatus" }, "ContentType": { "type": "string", "enum": [ "nosniff", "none" ], "title": "ContentType" }, "CorsHttpMethod": { "type": "string", "enum": [ "GET", "POST", "PUT", "DELETE", "HEAD" ], "title": "CorsHttpMethod" }, "CreateApplicationRequest": { "type": "object", "properties": { "source_control_provider_type": { "description": "The source control provider. This parameter will be required starting March 9, 2026.", "$ref": "#\/components\/schemas\/SourceControlProviderType" }, "repository": { "type": "string" }, "name": { "type": "string", "pattern": "^[\\p{Latin}0-9 _.,'\\-&()!#+:@]+$", "minLength": 3, "maxLength": 40 }, "region": { "$ref": "#\/components\/schemas\/CloudRegion" }, "root_directory": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9][-a-zA-Z0-9_.]*(?:\\\/[a-zA-Z0-9][-a-zA-Z0-9_.]*)*$", "maxLength": 255 }, "cluster_id": { "type": [ "string", "null" ], "description": "The identifier of a dedicated cluster to deploy to. Only fill it if your organization has a dedicated cluster and you want to use it for this application." } }, "required": [ "repository", "name", "region" ], "title": "CreateApplicationRequest" }, "CreateBackgroundProcessRequest": { "type": "object", "properties": { "type": { "$ref": "#\/components\/schemas\/DaemonType" }, "processes": { "type": "integer", "minimum": 1, "maximum": 10 }, "command": { "type": "string", "description": "Custom command to run. Required when type is 'custom'. Not applicable for 'worker' type.", "examples": [ "php artisan my:command" ] }, "config": { "type": "object", "properties": { "connection": { "type": "string", "description": "The queue connection name. Only applicable for 'worker' type background processes.", "examples": [ "redis" ] }, "queue": { "type": "string", "description": "The queue name(s) to process. Can be comma-separated for multiple queues. Only applicable for 'worker' type background processes.", "examples": [ "default,emails" ] }, "tries": { "type": "integer", "description": "Number of times a job should be attempted. Only applicable for 'worker' type background processes.", "examples": [ 3 ] }, "backoff": { "type": "integer", "description": "Number of seconds to wait before retrying a failed job. Only applicable for 'worker' type background processes.", "examples": [ 30 ] }, "sleep": { "type": "integer", "description": "Number of seconds to sleep when no jobs are available. Only applicable for 'worker' type background processes.", "examples": [ 3 ] }, "rest": { "type": "integer", "description": "Number of seconds to rest between jobs. Only applicable for 'worker' type background processes.", "examples": [ 0 ] }, "timeout": { "type": "integer", "description": "Number of seconds a job can run before timing out. Only applicable for 'worker' type background processes.", "examples": [ 60 ] }, "force": { "type": "boolean", "description": "Force the worker to run even in maintenance mode. Only applicable for 'worker' type background processes.", "examples": [ false ] } } } }, "required": [ "type", "processes" ], "title": "CreateBackgroundProcessRequest" }, "CreateCommandRequest": { "type": "object", "properties": { "command": { "type": "string", "minLength": 1, "maxLength": 150000 } }, "required": [ "command" ], "title": "CreateCommandRequest" }, "CreateDomainRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 3, "maxLength": 255 }, "www_redirect": { "anyOf": [ { "$ref": "#\/components\/schemas\/DomainRedirect" }, { "type": "null" } ] }, "wildcard_enabled": { "type": [ "boolean", "null" ], "description": "Whether to enable a wildcard subdomain (*.example.com) for this domain.", "examples": [ false ] }, "allow_downtime": { "type": [ "boolean", "null" ], "description": "Whether to allow downtime during domain verification. When true (flexible), the domain can be pointed directly without pre-verification. When false (uninterrupted), TXT-based pre-verification is required to avoid downtime.", "examples": [ true ] }, "cloudflare_strategy": { "anyOf": [ { "description": "The Cloudflare integration strategy. \"none\" uses A records with no Cloudflare integration. \"dns\" uses CNAME records via Cloudflare DNS only. \"dns_proxy\" uses CNAME records with Cloudflare's proxy enabled (Orange cloud).", "examples": [ "none" ], "$ref": "#\/components\/schemas\/DomainCloudflareStrategy" }, { "type": "null" } ] }, "verification_method": { "anyOf": [ { "description": "The domain verification method to use. Pre-verification allows domain verification via TXT record before the domain is pointed to the environment. Real-time verification requires the domain to already be pointing to the environment.", "examples": [ "real_time" ], "$ref": "#\/components\/schemas\/DomainVerificationMethod" }, { "type": "null" } ] } }, "required": [ "name" ], "title": "CreateDomainRequest" }, "CreateEnvironmentRequest": { "type": "object", "properties": { "branch": { "type": "string" }, "name": { "type": "string", "pattern": "^[A-Za-z0-9 _-]+$", "minLength": 1, "maxLength": 40 }, "cluster_id": { "type": [ "string", "null" ], "description": "The identifier of a dedicated cluster to deploy to. Only fill it if your organization has a dedicated cluster and you want to use it for this environment." } }, "required": [ "branch", "name" ], "title": "CreateEnvironmentRequest" }, "CreateInstanceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 3, "maxLength": 40 }, "type": { "type": "string", "enum": [ "service", "managed_queue" ] }, "size": { "$ref": "#\/components\/schemas\/InstanceSize" }, "scaling_type": { "$ref": "#\/components\/schemas\/InstanceScalingType" }, "max_replicas": { "type": "integer", "description": "The maximum number of replicas the instance can scale to. Only applicable to the `custom` scaling type, and rejected when used with `auto`.", "examples": [ 10 ] }, "min_replicas": { "type": "integer", "description": "The minimum number of replicas the instance runs. Only applicable to the `custom` scaling type, and rejected when used with `auto`. Not applicable to managed queues, which always scale to zero when idle.", "examples": [ 1 ] }, "uses_scheduler": { "type": "boolean" }, "sleep_with_app": { "type": "boolean", "description": "Whether worker replicas scale to zero alongside the app cluster, waking when they receive traffic. Only applicable to worker (service) instances.", "examples": [ true ] }, "scaling_cpu_threshold_percentage": { "type": [ "integer", "null" ], "minimum": 50, "maximum": 95 }, "scaling_memory_threshold_percentage": { "type": [ "integer", "null" ], "minimum": 50, "maximum": 95 }, "visibility_timeout": { "type": [ "integer", "null" ], "description": "How long a message stays hidden from other workers while one is processing it. Only available when the\norganization has the advanced managed queues entitlement; ignored otherwise, and the platform manages it.", "examples": [ 180 ] }, "shutdown_timeout": { "type": [ "integer", "null" ], "description": "The time a worker has to finish its current job before being forcefully shut down. Only available when the\norganization has the advanced managed queues entitlement; ignored otherwise, and the platform manages it.", "examples": [ 90 ] }, "background_processes": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#\/components\/schemas\/DaemonType" }, "processes": { "type": "integer", "minimum": 1, "maximum": 10 }, "command": { "type": "string", "description": "Custom command to run. Required when type is 'custom'. Not applicable for 'worker' type.", "examples": [ "php artisan my:command" ] }, "config": { "type": "object", "properties": { "connection": { "type": "string", "description": "The queue connection name. Only applicable for 'worker' type background processes. Managed queues must use 'cloud'.", "examples": [ "redis" ] }, "queue": { "type": "string", "description": "The queue name(s) to process. Can be comma-separated for multiple queues. Only applicable for 'worker' type background processes.", "examples": [ "default,emails" ] }, "tries": { "type": "integer", "description": "Number of times a job should be attempted. Only applicable for 'worker' type background processes.", "examples": [ 3 ] }, "backoff": { "type": "integer", "description": "Number of seconds to wait before retrying a failed job. Only applicable for 'worker' type background processes.", "examples": [ 30 ] }, "sleep": { "type": "integer", "description": "Number of seconds to sleep when no jobs are available. Only applicable for 'worker' type background processes.", "examples": [ 3 ] }, "rest": { "type": "integer", "description": "Number of seconds to rest between jobs. Only applicable for 'worker' type background processes.", "examples": [ 0 ] }, "timeout": { "type": "integer", "description": "Number of seconds a job can run before timing out. Only applicable for 'worker' type background processes.", "examples": [ 60 ] }, "force": { "type": "boolean", "description": "Force the worker to run even in maintenance mode. Only applicable for 'worker' type background processes.", "examples": [ false ] } } } }, "required": [ "type", "processes" ] } } }, "required": [ "name", "type", "size", "scaling_type", "min_replicas", "visibility_timeout", "shutdown_timeout" ], "title": "CreateInstanceRequest" }, "DaemonStrategyType": { "type": "string", "enum": [ "none", "growth_rate", "queue_size" ], "title": "DaemonStrategyType" }, "DaemonType": { "type": "string", "enum": [ "worker", "custom" ], "title": "DaemonType" }, "DatabaseDeploymentOption": { "type": "string", "enum": [ "single-az", "single-az-with-read-replicas", "multi-az" ], "title": "DatabaseDeploymentOption" }, "DatabaseResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "databases" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#\/components\/schemas\/DatabaseType" }, "status": { "$ref": "#\/components\/schemas\/DatabaseStatus" }, "region": { "$ref": "#\/components\/schemas\/CloudRegion" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "config": { "description": "Configuration object. Fields vary based on database type.", "oneOf": [ { "title": "Neon Serverless Postgres", "type": "object", "description": "Configuration for Neon Serverless Postgres databases", "properties": { "cu_min": { "type": "number", "description": "Minimum compute units for auto-scaling", "enum": [ 0.25, 0.5, 1, 2, 4, 8, 10 ] }, "cu_max": { "type": "number", "description": "Maximum compute units for auto-scaling", "enum": [ 0.25, 0.5, 1, 2, 4, 8, 10 ] }, "suspend_seconds": { "type": "integer", "description": "Seconds of inactivity before hibernation (0 = never, otherwise 60\u2013604800) (min: 0, max: 604800)" }, "retention_days": { "type": "integer", "description": "Days to retain point-in-time recovery data (min: 0, max: 30)" } }, "required": [ "cu_min", "cu_max", "suspend_seconds", "retention_days" ] }, { "title": "Laravel MySQL", "type": "object", "description": "Configuration for Laravel MySQL databases", "properties": { "size": { "type": "string", "description": "Instance size for the database cluster", "enum": [ "mysql-flex-512mb", "mysql-flex-1gb", "mysql-flex-2gb", "mysql-pro-4gb", "mysql-pro-8gb", "mysql-pro-16gb", "mysql-pro-32gb" ] }, "storage": { "type": "integer", "description": "Storage allocation in gigabytes (min: 5, max: 1000)" }, "is_public": { "type": "boolean", "description": "Whether the database is publicly accessible" }, "uses_scheduled_snapshots": { "type": "boolean", "description": "Whether scheduled backups are enabled" }, "retention_days": { "type": "integer", "description": "Days to retain backup data (min: 0, max: 30)" }, "maintenance_window": { "type": [ "string", "null" ], "description": "UTC maintenance window for automated updates", "examples": [ "sun:06:00-sun:06:30" ] }, "suspend_seconds": { "type": "integer", "description": "Seconds of inactivity before scaling to zero (0 = never). Requires an eligible size and the scale-to-zero feature. (min: 0, max: 3600)" } }, "required": [ "size", "storage", "is_public", "uses_scheduled_snapshots", "retention_days" ] }, { "title": "AWS RDS", "type": "object", "description": "Configuration for AWS RDS MySQL databases", "properties": { "size": { "type": "string", "description": "Instance size for the database cluster", "enum": [ "db.m8g.large", "db.m8g.xlarge", "db.m8g.2xlarge", "db.m8g.4xlarge", "db.m8g.8xlarge", "db.m8g.12xlarge", "db.m8g.16xlarge", "db.m8g.24xlarge", "db.m8g.48xlarge", "db.m7g.large", "db.m7g.xlarge", "db.m7g.2xlarge", "db.m7g.4xlarge", "db.m7g.8xlarge", "db.m7g.12xlarge", "db.m7g.16xlarge", "db.t4g.micro", "db.t4g.small", "db.t4g.medium", "db.t4g.large", "db.t4g.xlarge", "db.t4g.2xlarge", "db.r8g.large", "db.r8g.xlarge", "db.r8g.2xlarge", "db.r8g.4xlarge", "db.r8g.8xlarge", "db.r8g.12xlarge", "db.r8g.16xlarge" ] }, "storage": { "type": "integer", "description": "Storage allocation in gigabytes (min: 5, max: 1000)" }, "is_public": { "type": "boolean", "description": "Whether the database is publicly accessible" }, "uses_pitr": { "type": "boolean", "description": "Whether point-in-time recovery is enabled" }, "retention_days": { "type": "integer", "description": "Days to retain backup data (min: 0, max: 30)" }, "maintenance_window": { "type": [ "string", "null" ], "description": "UTC maintenance window for automated updates", "examples": [ "sun:06:00-sun:06:30" ] }, "deployment_option": { "type": "string", "description": "Deployment configuration (single-az or multi-az)", "enum": [ "single-az", "single-az-with-read-replicas", "multi-az" ] }, "read_replicas": { "type": [ "integer", "null" ], "description": "The number of configured read replicas" } }, "required": [ "size", "storage", "is_public", "uses_pitr", "retention_days", "deployment_option" ] } ], "discriminator": { "propertyName": "type", "mapping": { "laravel_mysql_84": "#\/components\/schemas\/LaravelMysqlConfig", "laravel_mysql_8": "#\/components\/schemas\/LaravelMysqlConfig", "aws_rds_mysql_8": "#\/components\/schemas\/AwsRdsConfig", "aws_rds_postgres_18": "#\/components\/schemas\/AwsRdsConfig", "neon_serverless_postgres_18": "#\/components\/schemas\/NeonServerlessConfig", "neon_serverless_postgres_17": "#\/components\/schemas\/NeonServerlessConfig", "neon_serverless_postgres_16": "#\/components\/schemas\/NeonServerlessConfig" } } }, "connection": { "type": "object", "properties": { "hostname": { "type": "string" }, "port": { "type": "integer", "enum": [ 3306, 5432 ] }, "protocol": { "type": "string", "enum": [ "mysql", "postgres" ] }, "driver": { "type": "string", "enum": [ "mysql", "pgsql" ] }, "": { "anyOf": [ { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "hostname", "port", "protocol", "driver", null ] } }, "required": [ "name", "type", "status", "region", "created_at", "config", "connection" ] }, "relationships": { "type": "object", "properties": { "schemas": { "type": "object", "description": "TODO: Remove the schemas relationship by March 2026.", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseSchemaResourceIdentifier" } } }, "required": [ "data" ] }, "databases": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DatabaseSchemaResourceIdentifier" } } }, "required": [ "data" ] } } } }, "required": [ "id", "type" ], "title": "DatabaseResource" }, "DatabaseResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "databases" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "DatabaseResourceIdentifier" }, "DatabaseSchemaResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "databaseSchemas" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "name", "status", "created_at" ] }, "relationships": { "type": "object", "properties": { "database": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/DatabaseResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] }, "environments": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EnvironmentResourceIdentifier" } } }, "required": [ "data" ] } } } }, "required": [ "id", "type" ], "title": "DatabaseSchemaResource" }, "DatabaseSchemaResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "databaseSchemas" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "DatabaseSchemaResourceIdentifier" }, "DatabaseSnapshotResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "database_snapshots" ] }, "attributes": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "type": { "$ref": "#\/components\/schemas\/DatabaseSnapshotType" }, "status": { "$ref": "#\/components\/schemas\/DatabaseSnapshotStatus" }, "storage_bytes": { "type": [ "integer", "null" ] }, "pitr_enabled": { "type": [ "boolean", "null" ] }, "pitr_ends_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "name", "description", "type", "status", "storage_bytes", "pitr_enabled", "pitr_ends_at", "completed_at", "created_at" ] }, "relationships": { "type": "object", "properties": { "database": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/DatabaseResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] } } }, "links": { "type": "object", "properties": { "self": { "$ref": "#\/components\/schemas\/Link" } }, "required": [ "self" ] } }, "required": [ "id", "type", "links" ], "title": "DatabaseSnapshotResource" }, "DatabaseSnapshotStatus": { "type": "string", "enum": [ "pending", "creating", "available", "failed", "deleting" ], "title": "DatabaseSnapshotStatus" }, "DatabaseSnapshotType": { "type": "string", "enum": [ "manual", "scheduled" ], "title": "DatabaseSnapshotType" }, "DatabaseStatus": { "type": "string", "enum": [ "creating", "updating", "restarting", "upgrading", "moving", "available", "stopped", "restoring", "restore_failed", "disabled", "snapshotting_before_archiving", "archiving", "archived", "deleting", "deleted", "unknown" ], "title": "DatabaseStatus" }, "DatabaseType": { "type": "string", "enum": [ "laravel_mysql_84", "laravel_mysql_8", "aws_rds_mysql_8", "aws_rds_postgres_18", "neon_serverless_postgres_18", "neon_serverless_postgres_17", "neon_serverless_postgres_16" ], "title": "DatabaseType" }, "DeleteEnvironmentVariablesRequest": { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" }, "minItems": 1 } }, "required": [ "keys" ], "title": "DeleteEnvironmentVariablesRequest" }, "DeploymentResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "deployments" ] }, "attributes": { "type": "object", "properties": { "status": { "$ref": "#\/components\/schemas\/DeploymentStatus" }, "branch_name": { "type": "string" }, "commit_hash": { "type": "string" }, "commit_message": { "type": "string" }, "commit_author": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "php_major_version": { "type": "string", "enum": [ "8.2", "8.3", "8.4", "8.5" ] }, "build_command": { "type": [ "string", "null" ] }, "node_version": { "$ref": "#\/components\/schemas\/NodeVersion" }, "uses_octane": { "type": "boolean" }, "uses_hibernation": { "type": "boolean" }, "hibernation_wake_up_interval": { "type": [ "integer", "null" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "finished_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "status", "branch_name", "commit_hash", "commit_message", "commit_author", "failure_reason", "php_major_version", "build_command", "node_version", "uses_octane", "uses_hibernation", "hibernation_wake_up_interval", "started_at", "finished_at" ] }, "relationships": { "type": "object", "properties": { "environment": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] }, "initiator": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/UserResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] } } }, "links": { "type": "object", "properties": { "self": { "$ref": "#\/components\/schemas\/Link" } }, "required": [ "self" ] } }, "required": [ "id", "type", "links" ], "title": "DeploymentResource" }, "DeploymentResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "deployments" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "DeploymentResourceIdentifier" }, "DeploymentStatus": { "type": "string", "enum": [ "pending", "build.pending", "build.created", "build.queued", "build.running", "build.succeeded", "build.failed", "cancelled", "failed", "deployment.pending", "deployment.created", "deployment.queued", "deployment.running", "deployment.succeeded", "deployment.failed" ], "title": "DeploymentStatus" }, "DomainActionRequired": { "type": "string", "enum": [ "add_txt_records", "add_dns_records", "failed" ], "title": "DomainActionRequired" }, "DomainCloudflareStrategy": { "type": "string", "enum": [ "dns_proxy", "dns", "none" ], "title": "DomainCloudflareStrategy" }, "DomainRedirect": { "type": "string", "enum": [ "root_to_www", "www_to_root" ], "title": "DomainRedirect" }, "DomainResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "domains" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#\/components\/schemas\/DomainType" }, "hostname_status": { "$ref": "#\/components\/schemas\/DomainStatus" }, "ssl_status": { "$ref": "#\/components\/schemas\/DomainStatus" }, "origin_status": { "$ref": "#\/components\/schemas\/DomainStatus" }, "redirect": { "anyOf": [ { "$ref": "#\/components\/schemas\/DomainRedirect" }, { "type": "null" } ] }, "cloudflare_strategy": { "anyOf": [ { "$ref": "#\/components\/schemas\/DomainCloudflareStrategy" }, { "type": "null" } ] }, "downtime": { "type": [ "boolean", "null" ] }, "wildcard_enabled": { "type": "boolean" }, "dns_records": { "type": "object", "properties": { "ssl": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CNAME", "TXT" ] }, "name": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "type", "name", "value" ] } }, "pre_verification": { "type": "string" }, "origin": { "type": "string" }, "origin_cname": { "type": "string" }, "dcv": { "type": "string" } }, "required": [ "ssl", "pre_verification", "origin", "origin_cname", "dcv" ] }, "wildcard": { "type": [ "object", "null" ], "properties": { "hostname_status": { "$ref": "#\/components\/schemas\/DomainStatus" }, "ssl_status": { "$ref": "#\/components\/schemas\/DomainStatus" }, "origin_status": { "$ref": "#\/components\/schemas\/DomainStatus" }, "dns_records": { "type": "object", "properties": { "ssl": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CNAME", "TXT" ] }, "name": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "type", "name", "value" ] } }, "pre_verification": { "type": "string" }, "origin": { "type": "string" }, "origin_cname": { "type": "string" }, "dcv": { "type": "string" } }, "required": [ "ssl", "pre_verification", "origin", "origin_cname", "dcv" ] } }, "required": [ "hostname_status", "ssl_status", "origin_status", "dns_records" ] }, "www": { "type": [ "object", "null" ], "properties": { "hostname_status": { "$ref": "#\/components\/schemas\/DomainStatus" }, "ssl_status": { "$ref": "#\/components\/schemas\/DomainStatus" }, "origin_status": { "$ref": "#\/components\/schemas\/DomainStatus" }, "dns_records": { "type": "object", "properties": { "ssl": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CNAME", "TXT" ] }, "name": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "type", "name", "value" ] } }, "pre_verification": { "type": "string" }, "origin": { "type": "string" }, "origin_cname": { "type": "string" }, "dcv": { "type": "string" } }, "required": [ "ssl", "pre_verification", "origin", "origin_cname", "dcv" ] } }, "required": [ "hostname_status", "ssl_status", "origin_status", "dns_records" ] }, "action_required": { "anyOf": [ { "$ref": "#\/components\/schemas\/DomainActionRequired" }, { "type": "null" } ] }, "last_verified_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "name", "type", "hostname_status", "ssl_status", "origin_status", "redirect", "cloudflare_strategy", "downtime", "wildcard_enabled", "dns_records", "wildcard", "www", "action_required", "last_verified_at", "created_at" ] }, "relationships": { "type": "object", "properties": { "environment": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] } } }, "links": { "type": "object", "properties": { "self": { "$ref": "#\/components\/schemas\/Link" } }, "required": [ "self" ] } }, "required": [ "id", "type", "links" ], "title": "DomainResource" }, "DomainResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "domains" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "DomainResourceIdentifier" }, "DomainStatus": { "type": "string", "enum": [ "pending", "verified", "failed", "disabled" ], "title": "DomainStatus" }, "DomainType": { "type": "string", "enum": [ "root", "www", "wildcard" ], "title": "DomainType" }, "DomainVerificationMethod": { "type": "string", "enum": [ "pre_verification", "real_time" ], "title": "DomainVerificationMethod" }, "EnvironmentColor": { "type": "string", "enum": [ "blue", "green", "orange", "purple", "red", "yellow", "cyan", "gray" ], "title": "EnvironmentColor" }, "EnvironmentResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "environments" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" }, "status": { "$ref": "#\/components\/schemas\/EnvironmentStatus" }, "created_from_automation": { "type": "boolean" }, "vanity_domain": { "type": "string" }, "php_major_version": { "type": "string", "enum": [ "8.2", "8.3", "8.4", "8.5" ] }, "build_command": { "type": [ "string", "null" ] }, "node_version": { "$ref": "#\/components\/schemas\/NodeVersion" }, "deploy_command": { "type": [ "string", "null" ] }, "uses_octane": { "type": "boolean" }, "uses_hibernation": { "type": "boolean" }, "hibernation_wake_up_interval": { "type": [ "integer", "null" ] }, "uses_push_to_deploy": { "type": "boolean" }, "uses_deploy_hook": { "type": "boolean" }, "": { "anyOf": [ { "type": "object", "properties": { "environment_variables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } } }, "required": [ "environment_variables" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "network_settings": { "type": "object", "properties": { "cache": { "type": "object", "properties": { "strategy": { "type": "string" } }, "required": [ "strategy" ] }, "response_headers": { "type": "object", "properties": { "frame": { "type": "string" }, "content_type": { "type": "string" }, "hsts": { "type": "object", "properties": { "max_age": { "type": "integer" }, "include_subdomains": { "type": "boolean" }, "preload": { "type": "boolean" } }, "required": [ "max_age", "include_subdomains", "preload" ] } }, "required": [ "frame", "content_type", "hsts" ] }, "firewall": { "type": "object", "properties": { "bot_categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BotControlCategory" } }, "rate_limit": { "type": "object", "properties": { "level": { "$ref": "#\/components\/schemas\/RateLimitLevel" }, "per_minute": { "$ref": "#\/components\/schemas\/RateLimitPerMinute" }, "4xx": { "type": "boolean" }, "429": { "type": "boolean" } }, "required": [ "level", "per_minute", "4xx", "429" ] }, "under_attack_mode_started_at": { "type": "string" }, "block_path": { "type": "boolean" } }, "required": [ "bot_categories", "rate_limit", "under_attack_mode_started_at", "block_path" ] }, "content_converter": { "type": "boolean" } }, "required": [ "cache", "response_headers", "firewall", "content_converter" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "name", "slug", "status", "created_from_automation", "vanity_domain", "php_major_version", "build_command", "node_version", "deploy_command", "uses_octane", "uses_hibernation", "hibernation_wake_up_interval", "uses_push_to_deploy", "uses_deploy_hook", null, "network_settings", "created_at" ] }, "relationships": { "type": "object", "properties": { "application": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/ApplicationResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] }, "branch": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/BranchResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] }, "deployments": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DeploymentResourceIdentifier" } } }, "required": [ "data" ] }, "currentDeployment": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/DeploymentResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] }, "domains": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DomainResourceIdentifier" } } }, "required": [ "data" ] }, "primaryDomain": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/DomainResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] }, "instances": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InstanceResourceIdentifier" } } }, "required": [ "data" ] }, "database": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/DatabaseSchemaResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] }, "cache": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/CacheResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] }, "buckets": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FilesystemResourceIdentifier" } } }, "required": [ "data" ] }, "websocketApplication": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/WebsocketApplicationResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] } } }, "links": { "type": "object", "properties": { "self": { "$ref": "#\/components\/schemas\/Link" } }, "required": [ "self" ] } }, "required": [ "id", "type", "links" ], "title": "EnvironmentResource" }, "EnvironmentResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "environments" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "EnvironmentResourceIdentifier" }, "EnvironmentStatus": { "type": "string", "enum": [ "deploying", "running", "hibernating", "stopped" ], "title": "EnvironmentStatus" }, "EnvironmentVariablesInsertMethod": { "type": "string", "enum": [ "append", "set" ], "title": "EnvironmentVariablesInsertMethod" }, "ExitCode": { "type": "integer", "enum": [ 0, 1 ], "title": "ExitCode" }, "FilesystemJurisdiction": { "type": "string", "enum": [ "default", "eu" ], "title": "FilesystemJurisdiction" }, "FilesystemKeyPermission": { "type": "string", "enum": [ "read_write", "read_only" ], "title": "FilesystemKeyPermission" }, "FilesystemKeyResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "filesystemKeys" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "permission": { "$ref": "#\/components\/schemas\/FilesystemKeyPermission" }, "access_key_id": { "type": [ "string", "null" ] }, "access_key_secret": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "name", "permission", "access_key_id", "access_key_secret", "created_at" ] }, "relationships": { "type": "object", "properties": { "filesystem": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/FilesystemResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] } } } }, "required": [ "id", "type" ], "title": "FilesystemKeyResource" }, "FilesystemKeyResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "filesystemKeys" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "FilesystemKeyResourceIdentifier" }, "FilesystemResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "filesystems" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#\/components\/schemas\/FilesystemType" }, "status": { "$ref": "#\/components\/schemas\/FilesystemStatus" }, "visibility": { "$ref": "#\/components\/schemas\/FilesystemVisibility" }, "jurisdiction": { "$ref": "#\/components\/schemas\/FilesystemJurisdiction" }, "endpoint": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "allowed_origins": { "type": "null" }, "cors_settings": { "type": "null" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "name", "type", "status", "visibility", "jurisdiction", "endpoint", "url", "allowed_origins", "cors_settings", "created_at" ] }, "relationships": { "type": "object", "properties": { "keys": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FilesystemKeyResourceIdentifier" } } }, "required": [ "data" ] } } } }, "required": [ "id", "type" ], "title": "FilesystemResource" }, "FilesystemResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "filesystems" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "FilesystemResourceIdentifier" }, "FilesystemStatus": { "type": "string", "enum": [ "creating", "updating", "available", "deleting", "deleted", "unknown" ], "title": "FilesystemStatus" }, "FilesystemType": { "type": "string", "enum": [ "cloudflare_r2" ], "title": "FilesystemType" }, "FilesystemVisibility": { "type": "string", "enum": [ "private", "public" ], "title": "FilesystemVisibility" }, "Frame": { "type": "string", "enum": [ "deny", "sameorigin", "all" ], "title": "Frame" }, "InstanceResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "instances" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#\/components\/schemas\/InstanceType" }, "size": { "$ref": "#\/components\/schemas\/InstanceSize" }, "scaling_type": { "$ref": "#\/components\/schemas\/InstanceScalingType" }, "min_replicas": { "type": "integer" }, "max_replicas": { "type": "integer" }, "queue_status": { "anyOf": [ { "description": "Current lifecycle status of the managed queue. Null for non-queue instances.", "$ref": "#\/components\/schemas\/SqsQueueStatus" }, { "type": "null" } ] }, "paused": { "type": [ "boolean", "null" ], "description": "Whether the managed queue is currently paused. Null for non-queue instances." }, "is_default": { "type": [ "boolean", "null" ], "description": "Whether this is the environment's default managed queue. Null for non-queue instances." }, "visibility_timeout": { "type": [ "integer", "null" ], "description": "How long, in seconds (0\u201343200), a received job stays hidden from other workers before it becomes available again. Null for non-queue instances." }, "polling_interval": { "type": [ "integer", "null" ], "description": "How often, in seconds (1\u201360), the queue is polled for new jobs. Null for non-queue instances." }, "shutdown_timeout": { "type": [ "integer", "null" ] }, "uses_scheduler": { "type": "boolean" }, "sleep_with_app": { "type": [ "boolean", "null" ] }, "scaling_cpu_threshold_percentage": { "type": [ "integer", "null" ] }, "scaling_memory_threshold_percentage": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "name", "type", "size", "scaling_type", "min_replicas", "max_replicas", "queue_status", "paused", "is_default", "visibility_timeout", "polling_interval", "shutdown_timeout", "uses_scheduler", "sleep_with_app", "scaling_cpu_threshold_percentage", "scaling_memory_threshold_percentage", "created_at" ] }, "relationships": { "type": "object", "properties": { "environment": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] }, "backgroundProcesses": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BackgroundProcessResourceIdentifier" } } }, "required": [ "data" ] } } } }, "required": [ "id", "type" ], "title": "InstanceResource" }, "InstanceResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "instances" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "InstanceResourceIdentifier" }, "InstanceScalingType": { "type": "string", "enum": [ "none", "custom", "auto" ], "title": "InstanceScalingType" }, "InstanceSize": { "type": "string", "enum": [ "flex-512mb", "flex-1gb", "flex-2gb", "flex.c-1vcpu-256mb", "flex.g-1vcpu-512mb", "flex.m-1vcpu-1gb", "flex.c-2vcpu-512mb", "flex.g-2vcpu-1gb", "flex.m-2vcpu-2gb", "flex.c-4vcpu-1gb", "flex.g-4vcpu-2gb", "flex.m-4vcpu-4gb", "flex.c-8vcpu-2gb", "flex.g-8vcpu-4gb", "flex.m-8vcpu-8gb", "pro.c-1vcpu-1gb", "pro.g-1vcpu-2gb", "pro.m-1vcpu-4gb", "pro.c-2vcpu-2gb", "pro.g-2vcpu-4gb", "pro.m-2vcpu-8gb", "pro.c-4vcpu-4gb", "pro.g-4vcpu-8gb", "pro.m-4vcpu-16gb", "pro.c-8vcpu-8gb", "pro.g-8vcpu-16gb", "pro.m-8vcpu-32gb", "dedicated.c-1vcpu-2gb", "dedicated.g-1vcpu-4gb", "dedicated.m-1vcpu-8gb", "dedicated.c-2vcpu-4gb", "dedicated.g-2vcpu-8gb", "dedicated.m-2vcpu-16gb", "dedicated.c-4vcpu-8gb", "dedicated.g-4vcpu-16gb", "dedicated.m-4vcpu-32gb", "dedicated.c-8vcpu-16gb", "dedicated.g-8vcpu-32gb", "dedicated.m-8vcpu-64gb", "mq-pro-256mb", "mq-pro-512mb", "mq-pro-1gb", "mq-pro-2gb", "mq-pro-4gb", "mq-pro-8gb", "mq-dedicated-256mb", "mq-dedicated-512mb", "mq-dedicated-1gb", "mq-dedicated-2gb", "mq-dedicated-4gb", "mq-dedicated-8gb", "mq-dedicated-16gb", "mq.flex.256mb", "mq.flex.512mb", "mq.flex.1gb", "mq.flex.2gb", "mq.pro.256mb", "mq.pro.512mb", "mq.pro.1gb", "mq.pro.2gb", "mq.pro.4gb", "mq.pro.8gb", "mq.dedicated.flex.256mb", "mq.dedicated.flex.512mb", "mq.dedicated.flex.1gb", "mq.dedicated.flex.2gb", "mq.dedicated.pro.256mb", "mq.dedicated.pro.512mb", "mq.dedicated.pro.1gb", "mq.dedicated.pro.2gb", "mq.dedicated.pro.4gb", "mq.dedicated.pro.8gb", "mq.dedicated.pro.16gb" ], "title": "InstanceSize" }, "InstanceType": { "type": "string", "enum": [ "app", "service", "queue", "managed_queue" ], "title": "InstanceType" }, "Link": { "type": "object", "properties": { "href": { "type": "string", "format": "uri" }, "rel": { "type": "string" }, "describedby": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "hreflang": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "meta": { "type": "object" } }, "required": [ "href" ], "title": "Link" }, "ManagedQueueFailedJobResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "attributes": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "The job's display name (typically its class), or null when it cannot be determined from the payload." }, "queue": { "type": "string" }, "failed_at": { "type": [ "string", "null" ], "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "attempts": { "type": "string" }, "exception": { "type": "string" }, "retried_at": { "type": [ "string", "null" ], "format": "date-time" }, "retry_reserved_until": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "name", "queue", "failed_at", "started_at", "attempts", "exception", "retried_at", "retry_reserved_until" ] } }, "required": [ "id", "type" ], "title": "ManagedQueueFailedJobResource" }, "MetricPeriod": { "type": "string", "enum": [ "6h", "24h", "3d", "7d", "30d" ], "title": "MetricPeriod" }, "NodeVersion": { "type": "string", "enum": [ "20", "22", "24" ], "title": "NodeVersion" }, "NormalizedLogResource": { "type": "object", "properties": { "message": { "type": "string" }, "level": { "type": "string", "enum": [ "info", "warning", "error", "debug" ] }, "type": { "type": "string", "enum": [ "access", "application", "exception", "system" ] }, "logged_at": { "type": "string" }, "data": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "integer" }, "method": { "type": "string" }, "path": { "type": "string" }, "duration_ms": { "type": [ "number", "null" ] }, "bytes_sent": { "type": [ "integer", "null" ] }, "ip": { "type": [ "string", "null" ] }, "user_agent": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] } }, "required": [ "status", "method", "path", "duration_ms", "bytes_sent", "ip", "user_agent", "country" ] }, { "type": "object", "properties": { "channel": { "type": [ "string", "null" ] }, "context": { "type": [ "object", "null" ], "additionalProperties": {} }, "extra": { "type": [ "object", "null" ], "additionalProperties": {} } }, "required": [ "channel", "context", "extra" ] }, { "type": "object", "properties": { "class": { "type": [ "string", "null" ] }, "code": { "type": [ "integer", "null" ] }, "file": { "type": [ "string", "null" ] }, "trace": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "class", "code", "file", "trace" ] }, { "type": "object", "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "message", "level", "type", "logged_at", "data" ], "title": "NormalizedLogResource" }, "OrganizationResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "organizations" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } }, "required": [ "id", "type" ], "title": "OrganizationResource" }, "OrganizationResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "organizations" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "OrganizationResourceIdentifier" }, "PhpVersion": { "type": "string", "enum": [ "8.2:1", "8.3:1", "8.4:1", "8.5:1" ], "title": "PhpVersion" }, "RateLimitLevel": { "type": "string", "enum": [ "challenge", "throttle", "ban" ], "title": "RateLimitLevel" }, "RateLimitPerMinute": { "type": "integer", "enum": [ 100, 300, 500, 750, 1000 ], "title": "RateLimitPerMinute" }, "RepositoryResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "repositories" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "required": [ "id", "type" ], "title": "RepositoryResource" }, "RepositoryResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "repositories" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "RepositoryResourceIdentifier" }, "RobotsTag": { "type": "string", "enum": [ "index, follow", "noindex, nofollow" ], "title": "RobotsTag" }, "SimplifiedDomainResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "domains" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#\/components\/schemas\/DomainType" }, "hostname_status": { "$ref": "#\/components\/schemas\/DomainStatus" }, "ssl_status": { "$ref": "#\/components\/schemas\/DomainStatus" }, "origin_status": { "$ref": "#\/components\/schemas\/DomainStatus" }, "redirect": { "anyOf": [ { "$ref": "#\/components\/schemas\/DomainRedirect" }, { "type": "null" } ] }, "last_verified_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "name", "type", "hostname_status", "ssl_status", "origin_status", "redirect", "last_verified_at", "created_at" ] }, "relationships": { "type": "object", "properties": { "environment": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/EnvironmentResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] } } }, "links": { "type": "object", "properties": { "self": { "$ref": "#\/components\/schemas\/Link" } }, "required": [ "self" ] } }, "required": [ "id", "type", "links" ], "title": "SimplifiedDomainResource" }, "SourceControlProviderType": { "type": "string", "enum": [ "github", "gitlab", "bitbucket" ], "title": "SourceControlProviderType" }, "SqsQueueStatus": { "type": "string", "enum": [ "creating", "updating", "available", "deleting", "deleted", "unknown" ], "title": "SqsQueueStatus" }, "StartEnvironmentRequest": { "type": "object", "properties": { "redeploy": { "type": [ "boolean", "null" ], "description": "Pass true to redeploy the environment with the same commit as the latest deployment. Otherwise, the latest commit will be used." } }, "title": "StartEnvironmentRequest" }, "StoreCacheRequest": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "laravel_valkey", "upstash_redis", "aws_elasticache_valkey", "aws_elasticache_redis" ] }, "name": { "type": "string", "pattern": "^[a-z0-9_-]+$", "minLength": 3, "maxLength": 40 }, "region": { "$ref": "#\/components\/schemas\/CloudRegion" }, "size": { "$ref": "#\/components\/schemas\/CacheSize" }, "auto_upgrade_enabled": { "type": "boolean" }, "is_public": { "type": "boolean" }, "eviction_policy": { "anyOf": [ { "description": "Only available for Valkey. If not provided, allkeys-lru will be used.", "$ref": "#\/components\/schemas\/CacheEvictionPolicy" }, { "type": "null" } ] }, "uses_hibernation": { "type": "boolean" }, "hibernation_timeout": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": [ "string", "null" ] } ] } }, "required": [ "type", "name", "region", "size", "auto_upgrade_enabled", "is_public" ], "title": "StoreCacheRequest" }, "StoreDatabaseRequest": { "type": "object", "properties": { "type": { "$ref": "#\/components\/schemas\/DatabaseType" }, "name": { "type": "string", "pattern": "^[a-z0-9_-]+$", "minLength": 3, "maxLength": 40 }, "region": { "$ref": "#\/components\/schemas\/CloudRegion" }, "config": { "description": "Configuration object. Fields vary based on database type.", "oneOf": [ { "title": "Neon Serverless Postgres", "type": "object", "description": "Configuration for Neon Serverless Postgres databases", "properties": { "cu_min": { "type": "number", "description": "Minimum compute units for auto-scaling", "enum": [ 0.25, 0.5, 1, 2, 4, 8, 10 ] }, "cu_max": { "type": "number", "description": "Maximum compute units for auto-scaling", "enum": [ 0.25, 0.5, 1, 2, 4, 8, 10 ] }, "suspend_seconds": { "type": "integer", "description": "Seconds of inactivity before hibernation (0 = never, otherwise 60\u2013604800) (min: 0, max: 604800)" }, "retention_days": { "type": "integer", "description": "Days to retain point-in-time recovery data (min: 0, max: 30)" } }, "required": [ "cu_min", "cu_max", "suspend_seconds", "retention_days" ] }, { "title": "Laravel MySQL", "type": "object", "description": "Configuration for Laravel MySQL databases", "properties": { "size": { "type": "string", "description": "Instance size for the database cluster", "enum": [ "mysql-flex-512mb", "mysql-flex-1gb", "mysql-flex-2gb", "mysql-pro-4gb", "mysql-pro-8gb", "mysql-pro-16gb", "mysql-pro-32gb" ] }, "storage": { "type": "integer", "description": "Storage allocation in gigabytes (min: 5, max: 1000)" }, "is_public": { "type": "boolean", "description": "Whether the database is publicly accessible" }, "uses_scheduled_snapshots": { "type": "boolean", "description": "Whether scheduled backups are enabled" }, "retention_days": { "type": "integer", "description": "Days to retain backup data (min: 0, max: 30)" }, "maintenance_window": { "type": [ "string", "null" ], "description": "UTC maintenance window for automated updates", "examples": [ "sun:06:00-sun:06:30" ] }, "suspend_seconds": { "type": "integer", "description": "Seconds of inactivity before scaling to zero (0 = never). Requires an eligible size and the scale-to-zero feature. (min: 0, max: 3600)" } }, "required": [ "size", "storage", "is_public", "uses_scheduled_snapshots", "retention_days" ] }, { "title": "AWS RDS", "type": "object", "description": "Configuration for AWS RDS MySQL databases", "properties": { "size": { "type": "string", "description": "Instance size for the database cluster", "enum": [ "db.m8g.large", "db.m8g.xlarge", "db.m8g.2xlarge", "db.m8g.4xlarge", "db.m8g.8xlarge", "db.m8g.12xlarge", "db.m8g.16xlarge", "db.m8g.24xlarge", "db.m8g.48xlarge", "db.m7g.large", "db.m7g.xlarge", "db.m7g.2xlarge", "db.m7g.4xlarge", "db.m7g.8xlarge", "db.m7g.12xlarge", "db.m7g.16xlarge", "db.t4g.micro", "db.t4g.small", "db.t4g.medium", "db.t4g.large", "db.t4g.xlarge", "db.t4g.2xlarge", "db.r8g.large", "db.r8g.xlarge", "db.r8g.2xlarge", "db.r8g.4xlarge", "db.r8g.8xlarge", "db.r8g.12xlarge", "db.r8g.16xlarge" ] }, "storage": { "type": "integer", "description": "Storage allocation in gigabytes (min: 5, max: 1000)" }, "is_public": { "type": "boolean", "description": "Whether the database is publicly accessible" }, "uses_pitr": { "type": "boolean", "description": "Whether point-in-time recovery is enabled" }, "retention_days": { "type": "integer", "description": "Days to retain backup data (min: 0, max: 30)" }, "maintenance_window": { "type": [ "string", "null" ], "description": "UTC maintenance window for automated updates", "examples": [ "sun:06:00-sun:06:30" ] }, "deployment_option": { "type": "string", "description": "Deployment configuration (single-az or multi-az)", "enum": [ "single-az", "single-az-with-read-replicas", "multi-az" ] }, "read_replicas": { "type": [ "integer", "null" ], "description": "The number of configured read replicas" } }, "required": [ "size", "storage", "is_public", "uses_pitr", "retention_days", "deployment_option" ] } ], "discriminator": { "propertyName": "type", "mapping": { "laravel_mysql_84": "#\/components\/schemas\/LaravelMysqlConfig", "laravel_mysql_8": "#\/components\/schemas\/LaravelMysqlConfig", "aws_rds_mysql_8": "#\/components\/schemas\/AwsRdsConfig", "aws_rds_postgres_18": "#\/components\/schemas\/AwsRdsConfig", "neon_serverless_postgres_18": "#\/components\/schemas\/NeonServerlessConfig", "neon_serverless_postgres_17": "#\/components\/schemas\/NeonServerlessConfig", "neon_serverless_postgres_16": "#\/components\/schemas\/NeonServerlessConfig" } } }, "cluster_id": { "type": [ "integer", "null" ] } }, "required": [ "type", "name", "region", "config" ], "title": "StoreDatabaseRequest" }, "StoreDatabaseRestoreRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the new database created from the restore.", "pattern": "^[a-z0-9_-]+$", "minLength": 3, "maxLength": 40 }, "restore_time": { "type": [ "string", "null" ], "format": "date-time", "description": "The point in time to restore the database to. Must not be used with database_snapshot_id." }, "database_snapshot_id": { "type": [ "string", "null" ] } }, "required": [ "name" ], "title": "StoreDatabaseRestoreRequest" }, "StoreDatabaseSchemaRequest": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z0-9_-]+$", "minLength": 3, "maxLength": 40 } }, "required": [ "name" ], "title": "StoreDatabaseSchemaRequest" }, "StoreDatabaseSnapshotRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 40 } }, "required": [ "name" ], "title": "StoreDatabaseSnapshotRequest" }, "StoreEnvironmentVariablesRequest": { "type": "object", "properties": { "method": { "description": "When set to 'append', variables are added to the end without checking for duplicates.\nWhen set to 'set', variables with matching keys are updated; otherwise they are added.", "$ref": "#\/components\/schemas\/EnvironmentVariablesInsertMethod" }, "variables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" }, "value": { "type": "string" } }, "required": [ "key", "value" ] }, "minItems": 1, "maxItems": 200 } }, "required": [ "method", "variables" ], "title": "StoreEnvironmentVariablesRequest" }, "StoreFilesystemKeyRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 3, "maxLength": 40 }, "permission": { "$ref": "#\/components\/schemas\/FilesystemKeyPermission" } }, "required": [ "name", "permission" ], "title": "StoreFilesystemKeyRequest" }, "StoreFilesystemRequest": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z0-9_-]+$", "minLength": 3, "maxLength": 40 }, "visibility": { "$ref": "#\/components\/schemas\/FilesystemVisibility" }, "jurisdiction": { "$ref": "#\/components\/schemas\/FilesystemJurisdiction" }, "allowed_origins": { "type": [ "array", "null" ], "description": "This field is deprecated and will be removed May 17th, 2026. Please use `cors_settings.allowed_origins` instead.", "items": { "type": "string", "format": "uri" } }, "cors_settings": { "type": "object", "properties": { "allowed_origins": { "type": [ "array", "null" ], "items": { "type": "string", "format": "uri" } }, "allowed_methods": { "type": [ "array", "null" ], "items": { "$ref": "#\/components\/schemas\/CorsHttpMethod" }, "minItems": 1 }, "allowed_headers": { "type": [ "array", "null" ], "items": { "type": "string" } }, "expose_headers": { "type": [ "array", "null" ], "items": { "type": "string" } }, "max_age_seconds": { "type": [ "integer", "null" ], "minimum": 1 } } }, "key_name": { "type": "string", "minLength": 3, "maxLength": 40 }, "key_permission": { "$ref": "#\/components\/schemas\/FilesystemKeyPermission" } }, "required": [ "name", "visibility", "jurisdiction", "key_name", "key_permission" ], "title": "StoreFilesystemRequest" }, "StoreWebsocketApplicationRequest": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z0-9_-]+$", "minLength": 3, "maxLength": 40 }, "allowed_origins": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 255 } }, "ping_interval": { "type": "integer", "minimum": 1, "maximum": 60 }, "activity_timeout": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "name" ], "title": "StoreWebsocketApplicationRequest" }, "StoreWebsocketServerRequest": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z0-9_-]+$", "minLength": 3, "maxLength": 40 }, "type": { "$ref": "#\/components\/schemas\/WebsocketServerType" }, "region": { "$ref": "#\/components\/schemas\/CloudRegion" }, "max_connections": { "type": "integer" } }, "required": [ "name", "type", "region", "max_connections" ], "title": "StoreWebsocketServerRequest" }, "TenancyType": { "type": "string", "enum": [ "shared", "dedicated" ], "title": "TenancyType" }, "UpdateApplicationRequest": { "type": "object", "properties": { "source_control_provider_type": { "description": "The source control provider. This parameter will be required starting March 9, 2026.", "$ref": "#\/components\/schemas\/SourceControlProviderType" }, "name": { "type": "string", "pattern": "^[\\p{Latin}0-9 _.'-]+$", "minLength": 3, "maxLength": 40 }, "slug": { "type": "string", "minLength": 3 }, "default_environment_id": { "type": "string" }, "repository": { "type": "string" }, "slack_channel": { "type": [ "string", "null" ] } }, "title": "UpdateApplicationRequest" }, "UpdateBackgroundProcessRequest": { "type": "object", "properties": { "type": { "$ref": "#\/components\/schemas\/DaemonType" }, "processes": { "type": "integer", "minimum": 1, "maximum": 10 }, "command": { "type": "string", "description": "Custom command to run. Required when type is 'custom'. Not applicable for 'worker' type.", "examples": [ "php artisan my:command" ] }, "config": { "type": "object", "properties": { "connection": { "type": "string", "description": "The queue connection name. Only applicable for 'worker' type background processes.", "examples": [ "redis" ] }, "queue": { "type": "string", "description": "The queue name(s) to process. Can be comma-separated for multiple queues. Only applicable for 'worker' type background processes.", "examples": [ "default,emails" ] }, "tries": { "type": "integer", "description": "Number of times a job should be attempted. Only applicable for 'worker' type background processes.", "examples": [ 3 ] }, "backoff": { "type": "integer", "description": "Number of seconds to wait before retrying a failed job. Only applicable for 'worker' type background processes.", "examples": [ 30 ] }, "sleep": { "type": "integer", "description": "Number of seconds to sleep when no jobs are available. Only applicable for 'worker' type background processes.", "examples": [ 3 ] }, "rest": { "type": "integer", "description": "Number of seconds to rest between jobs. Only applicable for 'worker' type background processes.", "examples": [ 0 ] }, "timeout": { "type": "integer", "description": "Number of seconds a job can run before timing out. Only applicable for 'worker' type background processes.", "examples": [ 60 ] }, "force": { "type": "boolean", "description": "Force the worker to run even in maintenance mode. Only applicable for 'worker' type background processes.", "examples": [ false ] } } } }, "title": "UpdateBackgroundProcessRequest" }, "UpdateCacheRequest": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z0-9_-]+$", "minLength": 3, "maxLength": 40 }, "size": { "$ref": "#\/components\/schemas\/CacheSize" }, "auto_upgrade_enabled": { "type": "boolean" }, "is_public": { "type": "boolean" }, "eviction_policy": { "anyOf": [ { "description": "Only available for Valkey.", "$ref": "#\/components\/schemas\/CacheEvictionPolicy" }, { "type": "null" } ] }, "uses_hibernation": { "type": "boolean" }, "hibernation_timeout": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": [ "string", "null" ] } ] } }, "title": "UpdateCacheRequest" }, "UpdateDatabaseRequest": { "type": "object", "properties": { "config": { "description": "Configuration object. Fields vary based on database type.", "oneOf": [ { "title": "Neon Serverless Postgres", "type": "object", "description": "Configuration for Neon Serverless Postgres databases", "properties": { "cu_min": { "type": "number", "description": "Minimum compute units for auto-scaling", "enum": [ 0.25, 0.5, 1, 2, 4, 8, 10 ] }, "cu_max": { "type": "number", "description": "Maximum compute units for auto-scaling", "enum": [ 0.25, 0.5, 1, 2, 4, 8, 10 ] }, "suspend_seconds": { "type": "integer", "description": "Seconds of inactivity before hibernation (0 = never, otherwise 60\u2013604800) (min: 0, max: 604800)" }, "retention_days": { "type": "integer", "description": "Days to retain point-in-time recovery data (min: 0, max: 30)" } }, "required": [ "cu_min", "cu_max", "suspend_seconds", "retention_days" ] }, { "title": "Laravel MySQL", "type": "object", "description": "Configuration for Laravel MySQL databases", "properties": { "size": { "type": "string", "description": "Instance size for the database cluster", "enum": [ "mysql-flex-512mb", "mysql-flex-1gb", "mysql-flex-2gb", "mysql-pro-4gb", "mysql-pro-8gb", "mysql-pro-16gb", "mysql-pro-32gb" ] }, "storage": { "type": "integer", "description": "Storage allocation in gigabytes (min: 5, max: 1000)" }, "is_public": { "type": "boolean", "description": "Whether the database is publicly accessible" }, "uses_scheduled_snapshots": { "type": "boolean", "description": "Whether scheduled backups are enabled" }, "retention_days": { "type": "integer", "description": "Days to retain backup data (min: 0, max: 30)" }, "maintenance_window": { "type": [ "string", "null" ], "description": "UTC maintenance window for automated updates", "examples": [ "sun:06:00-sun:06:30" ] }, "suspend_seconds": { "type": "integer", "description": "Seconds of inactivity before scaling to zero (0 = never). Requires an eligible size and the scale-to-zero feature. (min: 0, max: 3600)" } }, "required": [ "size", "storage", "is_public", "uses_scheduled_snapshots", "retention_days" ] }, { "title": "AWS RDS", "type": "object", "description": "Configuration for AWS RDS MySQL databases", "properties": { "size": { "type": "string", "description": "Instance size for the database cluster", "enum": [ "db.m8g.large", "db.m8g.xlarge", "db.m8g.2xlarge", "db.m8g.4xlarge", "db.m8g.8xlarge", "db.m8g.12xlarge", "db.m8g.16xlarge", "db.m8g.24xlarge", "db.m8g.48xlarge", "db.m7g.large", "db.m7g.xlarge", "db.m7g.2xlarge", "db.m7g.4xlarge", "db.m7g.8xlarge", "db.m7g.12xlarge", "db.m7g.16xlarge", "db.t4g.micro", "db.t4g.small", "db.t4g.medium", "db.t4g.large", "db.t4g.xlarge", "db.t4g.2xlarge", "db.r8g.large", "db.r8g.xlarge", "db.r8g.2xlarge", "db.r8g.4xlarge", "db.r8g.8xlarge", "db.r8g.12xlarge", "db.r8g.16xlarge" ] }, "storage": { "type": "integer", "description": "Storage allocation in gigabytes (min: 5, max: 1000)" }, "is_public": { "type": "boolean", "description": "Whether the database is publicly accessible" }, "uses_pitr": { "type": "boolean", "description": "Whether point-in-time recovery is enabled" }, "retention_days": { "type": "integer", "description": "Days to retain backup data (min: 0, max: 30)" }, "maintenance_window": { "type": [ "string", "null" ], "description": "UTC maintenance window for automated updates", "examples": [ "sun:06:00-sun:06:30" ] }, "deployment_option": { "type": "string", "description": "Deployment configuration (single-az or multi-az)", "enum": [ "single-az", "single-az-with-read-replicas", "multi-az" ] }, "read_replicas": { "type": [ "integer", "null" ], "description": "The number of configured read replicas" } }, "required": [ "size", "storage", "is_public", "uses_pitr", "retention_days", "deployment_option" ] } ], "discriminator": { "propertyName": "type", "mapping": { "laravel_mysql_84": "#\/components\/schemas\/LaravelMysqlConfig", "laravel_mysql_8": "#\/components\/schemas\/LaravelMysqlConfig", "aws_rds_mysql_8": "#\/components\/schemas\/AwsRdsConfig", "aws_rds_postgres_18": "#\/components\/schemas\/AwsRdsConfig", "neon_serverless_postgres_18": "#\/components\/schemas\/NeonServerlessConfig", "neon_serverless_postgres_17": "#\/components\/schemas\/NeonServerlessConfig", "neon_serverless_postgres_16": "#\/components\/schemas\/NeonServerlessConfig" } } } }, "required": [ "config" ], "title": "UpdateDatabaseRequest" }, "UpdateDomainRequest": { "type": "object", "properties": { "verification_method": { "description": "The domain verification method to use. Pre-verification allows domain verification via TXT record before the domain is pointed to the environment. Real-time verification requires the domain to already be pointing to the environment.", "examples": [ "real_time" ], "$ref": "#\/components\/schemas\/DomainVerificationMethod" } }, "required": [ "verification_method" ], "title": "UpdateDomainRequest" }, "UpdateEnvironmentRequest": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[A-Za-z0-9 _-]+$", "minLength": 1, "maxLength": 40 }, "slug": { "type": "string", "minLength": 1 }, "color": { "$ref": "#\/components\/schemas\/EnvironmentColor" }, "branch": { "type": "string" }, "uses_push_to_deploy": { "type": "boolean" }, "uses_deploy_hook": { "type": "boolean" }, "timeout": { "type": "integer", "minimum": 5, "maximum": 60 }, "php_version": { "$ref": "#\/components\/schemas\/PhpVersion" }, "build_command": { "type": [ "string", "null" ], "maxLength": 2000 }, "node_version": { "$ref": "#\/components\/schemas\/NodeVersion" }, "deploy_command": { "type": [ "string", "null" ], "maxLength": 2000 }, "uses_vanity_domain": { "type": "boolean" }, "database_schema_id": { "type": [ "string", "null" ], "description": "The identifier of the database schema to attach to the environment. Send null or an empty string to detach the database, or skip it entirely to leave it unchanged." }, "cache_id": { "type": [ "string", "null" ], "description": "The identifier of the cache to attach to the environment. Send null or an empty string to detach the cache, or skip it entirely to leave it unchanged." }, "websocket_application_id": { "type": [ "string", "null" ], "description": "The identifier of the WebSocket application to attach to the environment. Send null or an empty string to detach the WebSocket application, or skip it entirely to leave it unchanged." }, "filesystem_keys": { "type": "array", "description": "An array of the object storage buckets that should be attached to the environment. Send an emtpy array ([]) to detach all buckets.", "items": { "type": "object", "properties": { "id": { "type": "string" }, "disk": { "type": "string", "pattern": "^[A-Za-z0-9 _-]+$", "minLength": 1, "maxLength": 40 }, "is_default_disk": { "type": "boolean" } }, "required": [ "id", "disk", "is_default_disk" ] } }, "uses_octane": { "type": "boolean" }, "sleep_timeout": { "type": "integer", "minimum": 1, "maximum": 60 }, "hibernation_wake_up_interval": { "type": [ "integer", "null" ], "description": "The periodic wake-up interval in minutes for hibernating environments. Send null to disable, or a value between 1 and 10080 (7 days) to enable. Requires hibernation to be enabled.", "minimum": 1, "maximum": 10080 }, "shutdown_timeout": { "type": "integer", "minimum": 1, "maximum": 600 }, "uses_purge_edge_cache_on_deploy": { "type": "boolean" }, "nightwatch_token": { "type": [ "string", "null" ], "minLength": 44, "maxLength": 44 }, "cache_strategy": { "$ref": "#\/components\/schemas\/CacheStrategy" }, "response_headers_frame": { "$ref": "#\/components\/schemas\/Frame" }, "response_headers_content_type": { "$ref": "#\/components\/schemas\/ContentType" }, "response_headers_robots_tag": { "$ref": "#\/components\/schemas\/RobotsTag" }, "response_headers_hsts": { "type": "object", "properties": { "max_age": { "type": [ "number", "null" ], "minimum": 0 }, "include_subdomains": { "type": "boolean" }, "preload": { "type": "boolean" } }, "required": [ "max_age", "include_subdomains", "preload" ] }, "firewall_block_path": { "type": "boolean" }, "firewall_browser_integrity_check": { "type": "boolean" } }, "title": "UpdateEnvironmentRequest" }, "UpdateFilesystemKeyRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 3, "maxLength": 40 } }, "required": [ "name" ], "title": "UpdateFilesystemKeyRequest" }, "UpdateFilesystemRequest": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z0-9_-]+$", "minLength": 3, "maxLength": 40 }, "visibility": { "$ref": "#\/components\/schemas\/FilesystemVisibility" }, "allowed_origins": { "type": [ "array", "null" ], "description": "This field is deprecated and will be removed May 17th, 2026. Please use `cors_settings.allowed_origins` instead.", "items": { "type": "string", "format": "uri" } }, "cors_settings": { "type": "object", "properties": { "allowed_origins": { "type": [ "array", "null" ], "items": { "type": "string", "format": "uri" } }, "allowed_methods": { "type": [ "array", "null" ], "items": { "$ref": "#\/components\/schemas\/CorsHttpMethod" }, "minItems": 1 }, "allowed_headers": { "type": [ "array", "null" ], "items": { "type": "string" } }, "expose_headers": { "type": [ "array", "null" ], "items": { "type": "string" } }, "max_age_seconds": { "type": [ "integer", "null" ], "minimum": 1 } } } }, "title": "UpdateFilesystemRequest" }, "UpdateInstanceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 3, "maxLength": 40 }, "size": { "$ref": "#\/components\/schemas\/InstanceSize" }, "scaling_type": { "$ref": "#\/components\/schemas\/InstanceScalingType" }, "max_replicas": { "type": "integer", "description": "The maximum number of replicas the instance can scale to. Only applicable to the `custom` scaling type, and rejected when used with `auto`.", "examples": [ 10 ] }, "min_replicas": { "type": "integer", "description": "The minimum number of replicas the instance runs. Only applicable to the `custom` scaling type, and rejected when used with `auto`.", "examples": [ 1 ] }, "hibernation_timeout": { "type": [ "integer", "null" ], "description": "Number of minutes before the application hibernates. Set to null to disable hibernation, or omit it to avoid changing the hibernation settings.\nTakes precedence over the deprecated uses_sleep_mode and sleep_timeout fields.", "examples": [ 5 ] }, "uses_sleep_mode": { "type": "boolean", "description": "Use hibernation_timeout instead.", "deprecated": true }, "sleep_timeout": { "type": "integer", "description": "Use hibernation_timeout instead.", "deprecated": true, "minimum": 1, "maximum": 60 }, "uses_scheduler": { "type": "boolean" }, "sleep_with_app": { "type": "boolean", "description": "Whether worker replicas scale to zero alongside the app cluster, waking when they receive traffic. Only applicable to worker (service) instances.", "examples": [ true ] }, "uses_octane": { "type": "boolean" }, "uses_inertia_ssr": { "type": "boolean" }, "scaling_cpu_threshold_percentage": { "type": [ "integer", "null" ], "minimum": 50, "maximum": 95 }, "scaling_memory_threshold_percentage": { "type": [ "integer", "null" ], "minimum": 50, "maximum": 95 }, "visibility_timeout": { "type": [ "integer", "null" ], "description": "How long a message stays hidden from other workers while one is processing it. Only available when the\norganization has the advanced managed queues entitlement; ignored otherwise, and the platform manages it.", "examples": [ 180 ] }, "shutdown_timeout": { "type": [ "integer", "null" ], "description": "The time a worker has to finish its current job before being forcefully shut down. Only available when the\norganization has the advanced managed queues entitlement; ignored otherwise, and the platform manages it.", "examples": [ 90 ] } }, "title": "UpdateInstanceRequest" }, "UpdateWebsocketApplicationRequest": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z0-9_-]+$", "minLength": 3, "maxLength": 40 }, "allowed_origins": { "type": "array", "items": { "type": "string", "maxLength": 255 } }, "ping_interval": { "type": "integer", "minimum": 1, "maximum": 60 }, "activity_timeout": { "type": "integer", "minimum": 1, "maximum": 60 } }, "title": "UpdateWebsocketApplicationRequest" }, "UpdateWebsocketServerRequest": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z0-9_-]+$", "minLength": 3, "maxLength": 40 }, "max_connections": { "description": "The number of maximum connections allowed for the WebSocket server. If passed, the connection distribution strategy will be set to EVENLY.", "$ref": "#\/components\/schemas\/WebsocketServerMaxConnection" } }, "title": "UpdateWebsocketServerRequest" }, "UserResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "users" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "avatar_url": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "name", "email", "avatar_url", "created_at" ] } }, "required": [ "id", "type" ], "title": "UserResource" }, "UserResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "users" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "UserResourceIdentifier" }, "WebsocketApplicationResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "websocketApplications" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "app_id": { "type": "string" }, "allowed_origins": { "type": "array", "items": {} }, "ping_interval": { "type": "integer" }, "activity_timeout": { "type": "integer" }, "max_message_size": { "type": "integer" }, "max_connections": { "type": "integer" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "": { "anyOf": [ { "type": "object", "properties": { "key": { "type": "string" }, "secret": { "type": "string" } }, "required": [ "key", "secret" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "name", "app_id", "allowed_origins", "ping_interval", "activity_timeout", "max_message_size", "max_connections", "created_at", null ] }, "relationships": { "type": "object", "properties": { "server": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/WebsocketServerResourceIdentifier" }, { "type": "null" } ] } }, "required": [ "data" ] } } } }, "required": [ "id", "type" ], "title": "WebsocketApplicationResource" }, "WebsocketApplicationResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "websocketApplications" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "WebsocketApplicationResourceIdentifier" }, "WebsocketServerConnectionDistributionStrategy": { "type": "string", "enum": [ "evenly", "custom" ], "title": "WebsocketServerConnectionDistributionStrategy" }, "WebsocketServerMaxConnection": { "type": "integer", "enum": [ 100, 200, 500, 2000, 5000, 10000 ], "title": "WebsocketServerMaxConnection" }, "WebsocketServerResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "websocketServers" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#\/components\/schemas\/WebsocketServerType" }, "region": { "$ref": "#\/components\/schemas\/CloudRegion" }, "status": { "$ref": "#\/components\/schemas\/WebsocketServerStatus" }, "max_connections": { "$ref": "#\/components\/schemas\/WebsocketServerMaxConnection" }, "connection_distribution_strategy": { "$ref": "#\/components\/schemas\/WebsocketServerConnectionDistributionStrategy" }, "hostname": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "name", "type", "region", "status", "max_connections", "connection_distribution_strategy", "hostname", "created_at" ] }, "relationships": { "type": "object", "properties": { "applications": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebsocketApplicationResourceIdentifier" } } }, "required": [ "data" ] } } } }, "required": [ "id", "type" ], "title": "WebsocketServerResource" }, "WebsocketServerResourceIdentifier": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "websocketServers" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "title": "WebsocketServerResourceIdentifier" }, "WebsocketServerStatus": { "type": "string", "enum": [ "creating", "updating", "available", "stopped", "deleting", "deleted", "unknown" ], "title": "WebsocketServerStatus" }, "WebsocketServerType": { "type": "string", "enum": [ "reverb" ], "title": "WebsocketServerType" } }, "responses": { "AuthorizationException": { "description": "Authorization error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ValidationException": { "description": "Validation error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } }, "ModelNotFoundException": { "description": "Not found", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } } } } }