Hosting
Lock a hosted diagram
Locks the diagram so it cannot be deleted, renamed or moved until you unlock it.
PUT
/user/diagrams/{id}/lockTL;DR
| Question | Answer |
|---|---|
| What does it do? | Lock a hosted diagram. |
| What does it take? | id in the path. |
| What does it return? | Status 204 with no body. |
| What can go wrong? | 401 not signed in; 403 the request came from an origin that may not make changes; 404 no such diagram; 429 too many requests. Every failure uses the one error envelope. |
What it does
Locks the diagram so it cannot be deleted, renamed or moved until you unlock it. Locking one that is already locked succeeds. A lock does not stop the plan's expiry. A diagram that is not yours is a 404.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 204 | Locked. | none |
| 401 | Not signed in. | ErrorResponse |
| 403 | The request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such diagram. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |