114 lines
2.3 KiB
Markdown
114 lines
2.3 KiB
Markdown
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#VPContent)
|
||
|
||
Return to top
|
||
|
||
Environment[](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#environment)
|
||
|
||
=================================================================================================================
|
||
|
||
GET
|
||
|
||
/projects/{uuid}/{environment\_name\_or\_uuid}
|
||
|
||
Get environment by name or UUID.
|
||
|
||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#authorizations)
|
||
|
||
-----------------------------------------------------------------------------------------------------------------------
|
||
|
||
bearerAuth
|
||
|
||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||
|
||
Type
|
||
|
||
HTTP (bearer)
|
||
|
||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#parameters)
|
||
|
||
---------------------------------------------------------------------------------------------------------------
|
||
|
||
### Path Parameters
|
||
|
||
uuid\*
|
||
|
||
Project UUID
|
||
|
||
Type
|
||
|
||
string
|
||
|
||
Required
|
||
|
||
environment\_name\_or\_uuid\*
|
||
|
||
Environment name or UUID
|
||
|
||
Type
|
||
|
||
string
|
||
|
||
Required
|
||
|
||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#responses)
|
||
|
||
-------------------------------------------------------------------------------------------------------------
|
||
|
||
200400401404422
|
||
|
||
Environment details
|
||
|
||
Content-Type
|
||
|
||
application/json
|
||
|
||
SchemaJSON
|
||
|
||
JSON
|
||
|
||
{
|
||
|
||
"id": 0,
|
||
|
||
"name": "string",
|
||
|
||
"project\_id": 0,
|
||
|
||
"created\_at": "string",
|
||
|
||
"updated\_at": "string",
|
||
|
||
"description": "string"
|
||
|
||
}
|
||
|
||
GET
|
||
|
||
/projects/{uuid}/{environment\_name\_or\_uuid}
|
||
|
||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#playground)
|
||
|
||
---------------------------------------------------------------------------------------------------------------
|
||
|
||
Authorization
|
||
|
||
bearerAuth
|
||
|
||
Variables
|
||
|
||
Key
|
||
|
||
Value
|
||
|
||
uuid\*
|
||
|
||
environment\_name\_or\_uuid\*
|
||
|
||
Try it out
|
||
|
||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#samples)
|
||
|
||
---------------------------------------------------------------------------------------------------------
|
||
|
||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|