Laravel Secrets API
The Secrets API from Laravel — 3 operation(s) for secrets.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/laravel:laravel-secrets-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Laravel Cloud Secrets API
version: 0.0.1
servers:
- url: https://cloud.laravel.com/api
security:
- http: []
tags:
- name: Secrets
paths:
/secrets/public-key:
get:
operationId: public.secrets.public-key
description: 'Get the active public key for the organization.
The public key can be used to seal values before creating or update secrets.'
summary: Get secrets public key
tags:
- Secrets
responses:
'200':
description: 'Generating the key pair on the fly must not turn this read into a 201.
`OrganizationKeyPairResource`'
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/OrganizationKeyPairResource'
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'
/secrets:
get:
operationId: public.secrets.index
description: Get a list of all secrets for the authenticated organization.
summary: List secrets
tags:
- Secrets
parameters:
- name: filter[key]
in: query
schema:
type: string
- name: sort
in: query
schema:
type: array
default:
- key
items:
type: string
enum:
- key
- -key
- created_at
- -created_at
explode: false
- name: include
in: query
schema:
type: array
items:
type: string
enum:
- environments
explode: false
responses:
'200':
description: Paginated set of `SecretResource`
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SecretResource'
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.secrets.store
description: 'Create a new secret for the authenticated organization.
The value must be sealed with the public key of the submitted key pair, both of which are
returned by the secrets public key endpoint, before it is submitted.'
summary: Create secret
tags:
- Secrets
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StoreSecretRequest'
responses:
'201':
description: '`SecretResource`'
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/SecretResource'
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'
/secrets/{secret}:
patch:
operationId: public.secrets.update
description: 'Update a secret. A new value must be sealed with the public key of the submitted key pair
before it is submitted.'
summary: Update secret
tags:
- Secrets
parameters:
- name: secret
in: path
required: true
description: The secret identifier
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSecretRequest'
responses:
'200':
description: '`SecretResource`'
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/SecretResource'
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.secrets.destroy
description: Delete a secret and detach it from every environment it is attached to.
summary: Delete secret
tags:
- Secrets
parameters:
- name: secret
in: path
required: true
description: The secret identifier
schema:
type: string
responses:
'204':
description: No content
'404':
$ref: '#/components/responses/ModelNotFoundException'
'403':
$ref: '#/components/responses/AuthorizationException'
components:
schemas:
InstanceResourceIdentifier:
type: object
properties:
type:
type: string
enum:
- instances
id:
type: string
required:
- type
- id
title: InstanceResourceIdentifier
WebsocketApplicationResourceIdentifier:
type: object
properties:
type:
type: string
enum:
- websocketApplications
id:
type: string
required:
- type
- id
title: WebsocketApplicationResourceIdentifier
CacheResourceIdentifier:
type: object
properties:
type:
type: string
enum:
- caches
id:
type: string
required:
- type
- id
title: CacheResourceIdentifier
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
ApplicationResourceIdentifier:
type: object
properties:
type:
type: string
enum:
- applications
id:
type: string
required:
- type
- id
title: ApplicationResourceIdentifier
BranchResourceIdentifier:
type: object
properties:
type:
type: string
enum:
- branches
id:
type: string
required:
- type
- id
title: BranchResourceIdentifier
EnvironmentColor:
type: string
enum:
- blue
- green
- orange
- purple
- red
- yellow
- cyan
- gray
title: EnvironmentColor
UpdateSecretRequest:
type: object
properties:
key_pair_id:
type: string
key:
type: string
pattern: ^[A-Za-z_][A-Za-z0-9_]*$
maxLength: 255
value:
type:
- string
- 'null'
maxLength: 7500
notes:
type:
- string
- 'null'
maxLength: 500
required:
- key
title: UpdateSecretRequest
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'
color:
$ref: '#/components/schemas/EnvironmentColor'
created_from_automation:
type: boolean
vanity_domain:
type: string
framework:
$ref: '#/components/schemas/Framework'
language:
$ref: '#/components/schemas/Language'
php_major_version:
type: string
serving:
type: string
build_command:
type:
- string
- 'null'
node_version:
$ref: '#/components/schemas/NodeVersion'
deploy_command:
type:
- string
- 'null'
start_command:
type:
- string
- 'null'
uses_octane:
type: boolean
uses_hibernation:
type: boolean
hibernation_wake_up_interval:
type:
- integer
- 'null'
timeout:
type: integer
description: The number of seconds the environment will wait for your application to respond before timing out. Changes take effect on the next deployment.
shutdown_timeout:
type: integer
description: The number of seconds to wait before stopping the previous deployment's compute instances, allowing it to finish processing requests and jobs after a new deployment becomes active. Changes take effect on the next deployment.
uses_push_to_deploy:
type: boolean
uses_deploy_hook:
type: boolean
resend:
type:
- object
- 'null'
properties:
from_address:
type: string
from_name:
type: string
key_name:
type: string
required:
- from_address
- from_name
- key_name
? ''
: 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
- color
- created_from_automation
- vanity_domain
- framework
- language
- php_major_version
- build_command
- node_version
- deploy_command
- start_command
- uses_octane
- uses_hibernation
- hibernation_wake_up_interval
- timeout
- shutdown_timeout
- uses_push_to_deploy
- uses_deploy_hook
- resend
- 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
secrets:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SecretResourceIdentifier'
required:
- data
links:
type: object
properties:
self:
$ref: '#/components/schemas/Link'
required:
- self
required:
- id
- type
- links
title: EnvironmentResource
Framework:
type: string
enum:
- laravel
- symfony
- jigsaw
- html
- php
- express
- hono
- nuxt
- next
- tanstack
- elysia
- nestjs
- astro
- javascript
- go
- ruby
- rails
- django
- fastapi
- flask
- python
- java
- spring
- rust
- axum
- rocket
- actix
- warp
title: Framework
RateLimitLevel:
type: string
enum:
- challenge
- throttle
- ban
title: RateLimitLevel
EnvironmentStatus:
type: string
enum:
- deploying
- running
- hibernating
- stopped
title: EnvironmentStatus
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
RateLimitPerMinute:
type: integer
enum:
- 100
- 300
- 500
- 750
- 1000
title: RateLimitPerMinute
StoreSecretRequest:
type: object
properties:
key_pair_id:
type: string
key:
type: string
pattern: ^[A-Za-z_][A-Za-z0-9_]*$
maxLength: 255
value:
type: string
maxLength: 7500
notes:
type:
- string
- 'null'
maxLength: 500
required:
- key_pair_id
- key
- value
title: StoreSecretRequest
DeploymentResourceIdentifier:
type: object
properties:
type:
type: string
enum:
- deployments
id:
type: string
required:
- type
- id
title: DeploymentResourceIdentifier
EnvironmentResourceIdentifier:
type: object
properties:
type:
type: string
enum:
- environments
id:
type: string
required:
- type
- id
title: EnvironmentResourceIdentifier
DatabaseSchemaResourceIdentifier:
type: object
properties:
type:
type: string
enum:
- databaseSchemas
id:
type: string
required:
- type
- id
title: DatabaseSchemaResourceIdentifier
DomainResourceIdentifier:
type: object
properties:
type:
type: string
enum:
- domains
id:
type: string
required:
- type
- id
title: DomainResourceIdentifier
FilesystemResourceIdentifier:
type: object
properties:
type:
type: string
enum:
- filesystems
id:
type: string
required:
- type
- id
title: FilesystemResourceIdentifier
OrganizationKeyPairResource:
type: object
properties:
id:
type: string
type:
type: string
enum:
- organizationKeyPairs
attributes:
type: object
properties:
public_key:
type: string
description: A base64-encoded public key that can be used to seal values.
required:
- public_key
required:
- id
- type
title: OrganizationKeyPairResource
SecretResourceIdentifier:
type: object
properties:
type:
type: string
enum:
- secrets
id:
type: string
required:
- type
- id
title: SecretResourceIdentifier
Language:
type: string
enum:
- html
- php
- javascript
- python
- go
- ruby
- java
- rust
title: Language
SecretResource:
type: object
properties:
id:
type: string
type:
type: string
enum:
- secrets
attributes:
type: object
properties:
key:
type: string
notes:
type:
- string
- 'null'
created_at:
type:
- string
- 'null'
format: date-time
updated_at:
type:
- string
- 'null'
format: date-time
required:
- key
- notes
- created_at
- updated_at
relationships:
type: object
properties:
environments:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/EnvironmentResourceIdentifier'
required:
- data
required:
- id
- type
title: SecretResource
NodeVersion:
type: string
enum:
- '20'
- '22'
- '24'
- '26'
title: NodeVersion
responses:
ModelNotFoundException:
description: Not found
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
AuthorizationException:
description: Authorization error
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Error overview.
required:
- message
securitySchemes:
http:
type: http
description: The Bearer Token generated on the Cloud UI.
scheme: bearer
bearerFormat: bearer
x-provenance:
method: harvested
publisher: Laravel
source: https://cloud.laravel.com/api-docs/api.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)