forked from cloudfoundry/cloud_controller_ng
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path_create.md.erb
More file actions
53 lines (42 loc) · 1.23 KB
/
_create.md.erb
File metadata and controls
53 lines (42 loc) · 1.23 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
### Create a stack
```
Example Request
```
```shell
curl "https://api.example.org/v3/stacks" \
-X POST \
-H "Authorization: bearer [token]" \
-H "Content-type: application/json" \
-d '{
"name": "my-stack",
"description": "Here is my stack!",
"state": "ACTIVE",
"state_reason": "",
}'
```
```
Example Response
```
```http
HTTP/1.1 201 Created
Content-Type: application/json
<%= yield_content :single_stack %>
```
#### Definition
`POST /v3/stacks`
#### Required parameters
Name | Type | Description
---- | ---- | -----------
**name** | _string_ | Name of the stack; must be unique and no longer than 250 characters
#### Optional parameters
Name | Type | Description | Default
---- | ---- | ----------- | -------
**description** | _string_ | Description of the stack; must no longer than 250 characters | `null`
**metadata.labels** | [_label object_](#labels) | Labels applied to the stack
**metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the stack
**state** | string | The state of the stack; valid states are: `ACTIVE`, `RESTRICTED`, `DEPRECATED`, `DISABLED`
**state_reason** | string | Optional plain text describing the stack state change
#### Permitted roles
|
--- | ---
Admin |