182 lines
3.1 KiB
Markdown
182 lines
3.1 KiB
Markdown
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-servers#VPContent)
|
||
|
||
Return to top
|
||
|
||
List[](https://coolify.io/docs/api-reference/api/operations/list-servers#list)
|
||
|
||
================================================================================
|
||
|
||
GET
|
||
|
||
/servers
|
||
|
||
List all servers.
|
||
|
||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-servers#authorizations)
|
||
|
||
----------------------------------------------------------------------------------------------------
|
||
|
||
bearerAuth
|
||
|
||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||
|
||
Type
|
||
|
||
HTTP (bearer)
|
||
|
||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-servers#responses)
|
||
|
||
------------------------------------------------------------------------------------------
|
||
|
||
200400401
|
||
|
||
Get all servers.
|
||
|
||
Content-Type
|
||
|
||
application/json
|
||
|
||
SchemaJSON
|
||
|
||
JSON
|
||
|
||
\[\
|
||
\
|
||
{\
|
||
\
|
||
"id": 0,\
|
||
\
|
||
"uuid": "string",\
|
||
\
|
||
"name": "string",\
|
||
\
|
||
"description": "string",\
|
||
\
|
||
"ip": "string",\
|
||
\
|
||
"user": "string",\
|
||
\
|
||
"port": 0,\
|
||
\
|
||
"proxy": {\
|
||
\
|
||
},\
|
||
\
|
||
"proxy\_type": "string",\
|
||
\
|
||
"high\_disk\_usage\_notification\_sent": true,\
|
||
\
|
||
"unreachable\_notification\_sent": true,\
|
||
\
|
||
"unreachable\_count": 0,\
|
||
\
|
||
"validation\_logs": "string",\
|
||
\
|
||
"log\_drain\_notification\_sent": true,\
|
||
\
|
||
"swarm\_cluster": "string",\
|
||
\
|
||
"settings": {\
|
||
\
|
||
"id": 0,\
|
||
\
|
||
"concurrent\_builds": 0,\
|
||
\
|
||
"deployment\_queue\_limit": 0,\
|
||
\
|
||
"dynamic\_timeout": 0,\
|
||
\
|
||
"force\_disabled": true,\
|
||
\
|
||
"force\_server\_cleanup": true,\
|
||
\
|
||
"is\_build\_server": true,\
|
||
\
|
||
"is\_cloudflare\_tunnel": true,\
|
||
\
|
||
"is\_jump\_server": true,\
|
||
\
|
||
"is\_logdrain\_axiom\_enabled": true,\
|
||
\
|
||
"is\_logdrain\_custom\_enabled": true,\
|
||
\
|
||
"is\_logdrain\_highlight\_enabled": true,\
|
||
\
|
||
"is\_logdrain\_newrelic\_enabled": true,\
|
||
\
|
||
"is\_metrics\_enabled": true,\
|
||
\
|
||
"is\_reachable": true,\
|
||
\
|
||
"is\_sentinel\_enabled": true,\
|
||
\
|
||
"is\_swarm\_manager": true,\
|
||
\
|
||
"is\_swarm\_worker": true,\
|
||
\
|
||
"is\_terminal\_enabled": true,\
|
||
\
|
||
"is\_usable": true,\
|
||
\
|
||
"logdrain\_axiom\_api\_key": "string",\
|
||
\
|
||
"logdrain\_axiom\_dataset\_name": "string",\
|
||
\
|
||
"logdrain\_custom\_config": "string",\
|
||
\
|
||
"logdrain\_custom\_config\_parser": "string",\
|
||
\
|
||
"logdrain\_highlight\_project\_id": "string",\
|
||
\
|
||
"logdrain\_newrelic\_base\_uri": "string",\
|
||
\
|
||
"logdrain\_newrelic\_license\_key": "string",\
|
||
\
|
||
"sentinel\_metrics\_history\_days": 0,\
|
||
\
|
||
"sentinel\_metrics\_refresh\_rate\_seconds": 0,\
|
||
\
|
||
"sentinel\_token": "string",\
|
||
\
|
||
"docker\_cleanup\_frequency": "string",\
|
||
\
|
||
"docker\_cleanup\_threshold": 0,\
|
||
\
|
||
"server\_id": 0,\
|
||
\
|
||
"wildcard\_domain": "string",\
|
||
\
|
||
"created\_at": "string",\
|
||
\
|
||
"updated\_at": "string",\
|
||
\
|
||
"delete\_unused\_volumes": true,\
|
||
\
|
||
"delete\_unused\_networks": true\
|
||
\
|
||
}\
|
||
\
|
||
}\
|
||
\
|
||
\]
|
||
|
||
GET
|
||
|
||
/servers
|
||
|
||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-servers#playground)
|
||
|
||
--------------------------------------------------------------------------------------------
|
||
|
||
Authorization
|
||
|
||
bearerAuth
|
||
|
||
Try it out
|
||
|
||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-servers#samples)
|
||
|
||
--------------------------------------------------------------------------------------
|
||
|
||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|