Skip to content

Commit 896aa69

Browse files
committed
Added Pods Docs
1 parent 0ecb6e0 commit 896aa69

File tree

3 files changed

+40
-1
lines changed

3 files changed

+40
-1
lines changed

source/includes/_pods.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# PODS
2+
3+
## Register a Pod UUID
4+
5+
Registers a new Pod in Recursion.Space by providing a UUID and any optional fields.
6+
7+
> `POST` /v1/pods
8+
9+
```shell
10+
curl -X POST "https://api.recursion.space/v1/pods" \
11+
-H "Content-Type: application/json" \
12+
-H "Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
13+
-d "uuid=xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx"
14+
```
15+
16+
### Parameters
17+
18+
| Field | Type | Required | Description |
19+
| ------ | ------------- | -------- | --------------------------------------------------------------- |
20+
| `uuid` | string (UUID) | true | The unique identifier for the Pod. Must be a valid UUID format. |
21+
22+
> Example Successful Response (HTTP 201 Created)
23+
24+
```shell
25+
HTTP/1.1 201 Created
26+
27+
{
28+
"id": 1,
29+
"uuid": "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx",
30+
"nickname": "",
31+
"serial": "",
32+
"version": "",
33+
"status": "0",
34+
"connection_last_made": "2025-02-09T05:59:08.947827Z",
35+
"snapshot": null,
36+
"facility": null
37+
}
38+
```

source/includes/_space.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ curl "https://api.recursion.space/v1/operators/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx"
7474
]
7575
```
7676

77-
Retrive information for all operators ("admins") for the selected space.
77+
Retrieve information for all operators ("admins") for the selected space.
7878

7979
### Returns
8080

source/index.html.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ includes:
1111
- errors
1212
- space
1313
- modules
14+
- pods
1415

1516
search: true
1617

0 commit comments

Comments
 (0)