Authorizations
The Bearer Token generated on the Cloud UI.
Path Parameters
The environment identifier
curl --request GET \
--url https://app.laravel.cloud/api/environments/{environment}/commands \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"type": "commands",
"attributes": {
"command": "<string>",
"output": "<string>",
"status": "pending",
"exit_code": 0,
"failure_reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"environment": {
"data": {
"type": "environments",
"id": "<string>"
}
},
"deployment": {
"data": {
"type": "deployments",
"id": "<string>"
}
},
"initiator": {
"data": {
"type": "users",
"id": "<string>"
}
}
},
"links": {
"self": {
"href": "<string>",
"rel": "<string>",
"describedby": "<string>",
"title": "<string>",
"type": "<string>",
"hreflang": "<string>",
"meta": {}
}
}
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 123,
"from": 123,
"last_page": 123,
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
],
"path": "<string>",
"per_page": 123,
"to": 123,
"total": 123
},
"included": [
{
"id": "<string>",
"type": "environments",
"attributes": {
"name": "<string>",
"slug": "<string>",
"status": "deploying",
"created_from_automation": true,
"vanity_domain": "<string>",
"php_major_version": "8.2",
"build_command": "<string>",
"node_version": "20",
"deploy_command": "<string>",
"uses_web_server": true,
"uses_octane": true,
"uses_hibernation": true,
"uses_push_to_deploy": true,
"uses_deploy_hook": true,
"environment_variables": [
{
"key": "<string>",
"value": "<string>"
}
],
"network_settings": {
"cache": {
"strategy": "<string>"
},
"response_headers": {
"frame": "<string>",
"content_type": "<string>",
"hsts": {
"max_age": 123,
"include_subdomains": true,
"preload": true
}
},
"firewall": {
"bot_categories": [
"academic_research"
],
"rate_limit": {
"429": true,
"level": "challenge",
"per_minute": 100,
"4xx": true
},
"under_attack_mode_started_at": "<string>"
}
},
"created_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"application": {
"data": {
"type": "applications",
"id": "<string>"
}
},
"branch": {
"data": {
"type": "branches",
"id": "<string>"
}
},
"deployments": {
"data": [
{
"type": "deployments",
"id": "<string>"
}
]
},
"currentDeployment": {
"data": {
"type": "deployments",
"id": "<string>"
}
},
"domains": {
"data": [
{
"type": "domains",
"id": "<string>"
}
]
},
"primaryDomain": {
"data": {
"type": "domains",
"id": "<string>"
}
},
"instances": {
"data": [
{
"type": "instances",
"id": "<string>"
}
]
}
},
"links": {
"self": {
"href": "<string>",
"rel": "<string>",
"describedby": "<string>",
"title": "<string>",
"type": "<string>",
"hreflang": "<string>",
"meta": {}
}
}
}
]
}Get a list of all commands for the given environment.
curl --request GET \
--url https://app.laravel.cloud/api/environments/{environment}/commands \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"type": "commands",
"attributes": {
"command": "<string>",
"output": "<string>",
"status": "pending",
"exit_code": 0,
"failure_reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"environment": {
"data": {
"type": "environments",
"id": "<string>"
}
},
"deployment": {
"data": {
"type": "deployments",
"id": "<string>"
}
},
"initiator": {
"data": {
"type": "users",
"id": "<string>"
}
}
},
"links": {
"self": {
"href": "<string>",
"rel": "<string>",
"describedby": "<string>",
"title": "<string>",
"type": "<string>",
"hreflang": "<string>",
"meta": {}
}
}
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 123,
"from": 123,
"last_page": 123,
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
],
"path": "<string>",
"per_page": 123,
"to": 123,
"total": 123
},
"included": [
{
"id": "<string>",
"type": "environments",
"attributes": {
"name": "<string>",
"slug": "<string>",
"status": "deploying",
"created_from_automation": true,
"vanity_domain": "<string>",
"php_major_version": "8.2",
"build_command": "<string>",
"node_version": "20",
"deploy_command": "<string>",
"uses_web_server": true,
"uses_octane": true,
"uses_hibernation": true,
"uses_push_to_deploy": true,
"uses_deploy_hook": true,
"environment_variables": [
{
"key": "<string>",
"value": "<string>"
}
],
"network_settings": {
"cache": {
"strategy": "<string>"
},
"response_headers": {
"frame": "<string>",
"content_type": "<string>",
"hsts": {
"max_age": 123,
"include_subdomains": true,
"preload": true
}
},
"firewall": {
"bot_categories": [
"academic_research"
],
"rate_limit": {
"429": true,
"level": "challenge",
"per_minute": 100,
"4xx": true
},
"under_attack_mode_started_at": "<string>"
}
},
"created_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"application": {
"data": {
"type": "applications",
"id": "<string>"
}
},
"branch": {
"data": {
"type": "branches",
"id": "<string>"
}
},
"deployments": {
"data": [
{
"type": "deployments",
"id": "<string>"
}
]
},
"currentDeployment": {
"data": {
"type": "deployments",
"id": "<string>"
}
},
"domains": {
"data": [
{
"type": "domains",
"id": "<string>"
}
]
},
"primaryDomain": {
"data": {
"type": "domains",
"id": "<string>"
}
},
"instances": {
"data": [
{
"type": "instances",
"id": "<string>"
}
]
}
},
"links": {
"self": {
"href": "<string>",
"rel": "<string>",
"describedby": "<string>",
"title": "<string>",
"type": "<string>",
"hreflang": "<string>",
"meta": {}
}
}
}
]
}The Bearer Token generated on the Cloud UI.
The environment identifier
Paginated set of CommandResource
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?