Get all deployments

get/deployments

Returns a list of all deployments, including details of the deployments such as assigned ESP servers and running projects.

Request Samples

1

Response Samples

1{
2 "accept": "application/json",
3 "count": 2,
4 "items": [
5 {
6 "createdBy": "user1",
7 "createdOn": 1675175931010,
8 "deleted": false,
9 "description": "Created by user1",
10 "label": "deploy2",
11 "modifiedBy": "user1",
12 "modifiedOn": 1675175931010,
13 "production": true,
14 "projectStatuses": {},
15 "serverCount": 0,
16 "serverStatuses": {},
17 "servers": [
18 {
19 "adminPort": 7010,
20 "autoRegistered": false,
21 "clusterServer": false,
22 "combinedWindows": [],
23 "equipment": {
24 "diskSpace": 0,
25 "friendlyName": "espServer1",
26 "health": 0,
27 "hostName": "esp-server01.sas.com",
28 "id": "-1358091958",
29 "ipAddress": "esp-server01.sas.com",
30 "memoryUse": 0
31 },
32 "espServerId": "fba3b637-c55c-4ddb-91f5-f5635adfcb13",
33 "friendlyName": "ESPServer1",
34 "health": true,
35 "hostName": "esp-server01.sas.com",
36 "httpPort": 7010,
37 "id": "-1358091958",
38 "ipAddress": "esp-server01.sas.com",
39 "kerberosEnabled": false,
40 "memoryUsage": 0,
41 "metering": false,
42 "parameters": [],
43 "projects": [],
44 "pubSubPort": 7010,
45 "residentMemoryUsage": 0,
46 "ssl": false,
47 "state": "AVAILABLE",
48 "useAuthzHeader": false,
49 "version": "2022.12(7.32#2731)",
50 "virtualMemoryUsage": 0
51 }
52 ],
53 "tags": [
54 "Second deployment"
55 ],
56 "type": "cluster",
57 "uuid": "b61a2dc9-beef-4f11-ab9b-ad0aa74f3e9f"
58 },
59 {
60 "createdBy": "user1",
61 "createdOn": 1675175930968,
62 "deleted": false,
63 "description": "Created by user1",
64 "label": "deployment1",
65 "modifiedBy": "user1",
66 "modifiedOn": 1675175930968,
67 "production": true,
68 "projectStatuses": {},
69 "serverCount": 0,
70 "serverStatuses": {},
71 "servers": [],
72 "tags": [
73 "First deployment"
74 ],
75 "type": "cluster",
76 "uuid": "b0d4a2df-3e04-4212-b0bb-bd5b74870144"
77 }
78 ],
79 "limit": 50,
80 "name": "items",
81 "start": -1,
82 "version": 2
83}

Query Parameters

NameTypeRequiredDescription
filter
string
false

The filter parameter.

limit
integer<int32>
false

The maximum number of records to be returned.

>= 1<= 100
Default:
50
noDetails
boolean
false

When true, details of servers and projects are not included

Default:
false
start
integer<int64>
false

The number of the first record to be returned.

>= -1
Default:
-1
suitableFor
string
false

If this parameter is set to production, then only production deployments are returned. If this parameter is set to test, then only non-production deployments are returned. Otherwise, deployments are returned regardless of their production status.

Allowed values:
productiontest

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema