nginx-proxy-manager/backend/embed/api_docs/paths/streams/streamID/delete.json

{
	"operationId": "deleteStream",
	"summary": "Delete a Stream",
	"tags": [
		"Streams"
	],
	"parameters": [
		{
			"in": "path",
			"name": "streamID",
			"schema": {
				"type": "integer",
				"minimum": 1
			},
			"required": true,
			"description": "Numeric ID of the Stream",
			"example": 1
		}
	],
	"responses": {
		"200": {
			"description": "200 response",
			"content": {
				"application/json": {
					"schema": {
						"$ref": "#/components/schemas/DeletedItemResponse"
					},
					"examples": {
						"default": {
							"value": {
								"result": true
							}
						}
					}
				}
			}
		},
		"400": {
			"description": "400 response",
			"content": {
				"application/json": {
					"schema": {
						"$ref": "#/components/schemas/DeletedItemResponse"
					},
					"examples": {
						"default": {
							"value": {
								"result": null,
								"error": {
									"code": 400,
									"message": "You cannot delete a Stream that is in use!"
								}
							}
						}
					}
				}
			}
		}
	}
}