> For the complete documentation index, see [llms.txt](https://docs.enlyze.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.enlyze.com/enlyze-api/api-referenz/downtime-catalogs.md).

# Downtime Catalogs

⚠️ **Experimental** — this resource is under active development and may change without notice.

## Get Downtime Catalogs

> Returns a list of downtime catalogs in your organization.

```json
{"openapi":"3.1.0","info":{"title":"ENLYZE API","version":"v2"},"tags":[{"name":"Downtime Catalogs","description":"⚠️ **Experimental** — this resource is under active development and may change without notice."}],"servers":[{"url":"/api"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DowntimeCatalogState":{"type":"string","enum":["active","archived"],"title":"DowntimeCatalogState"},"PaginatedDowntimeCatalogs":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DowntimeCatalog"},"type":"array","title":"Data"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"This field contains pagination metadata."}},"additionalProperties":false,"type":"object","required":["data","metadata"],"title":"PaginatedDowntimeCatalogs"},"DowntimeCatalog":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Downtime Catalog UUID","description":"The UUID of the downtime catalog."},"name":{"type":"string","title":"Name","description":"Name of the downtime catalog."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Free-text description of the downtime catalog."},"state":{"$ref":"#/components/schemas/DowntimeCatalogState","title":"State","description":"Lifecycle state of the downtime catalog."}},"type":"object","required":["uuid","name","state"],"title":"DowntimeCatalog"},"Metadata":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"Pagination continuation point. Specify its value as the `cursor` parameter in a request with otherwise the same parameters to fetch the next page. `None`, if there is no more data to be fetched from the server."}},"additionalProperties":false,"type":"object","required":["next_cursor"],"title":"Metadata"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v2/downtime-catalogs":{"get":{"tags":["Downtime Catalogs"],"summary":"Get Downtime Catalogs","description":"Returns a list of downtime catalogs in your organization.","operationId":"get_downtime_catalogs_v2_downtime_catalogs_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"type":"string","title":"Get page starting at cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"title":"Maximum number of results to return","description":"Caps the page size. Defaults to 1000, which is also the maximum; a value below 1 or above 1000 is rejected.","default":1000},"description":"Caps the page size. Defaults to 1000, which is also the maximum; a value below 1 or above 1000 is rejected."},{"name":"uuid","in":"query","required":false,"schema":{"anyOf":[{"type":"array","uniqueItems":true,"items":{"type":"string","format":"uuid"},"maxItems":50},{"type":"null"}],"title":"Filter by one or more downtime catalog UUIDs.","description":"If not set, all downtime catalogs will be considered."},"description":"If not set, all downtime catalogs will be considered."},{"name":"machine","in":"query","required":false,"schema":{"anyOf":[{"type":"array","uniqueItems":true,"items":{"type":"string","format":"uuid"},"maxItems":50},{"type":"null"}],"title":"Filter by one or more machine UUIDs.","description":"Only return catalogs assigned to any of the given machines. If not set, catalogs for all machines (including unassigned catalogs) will be considered."},"description":"Only return catalogs assigned to any of the given machines. If not set, catalogs for all machines (including unassigned catalogs) will be considered."},{"name":"unassigned","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Filter for unassigned catalogs","description":"If true, only return catalogs that are not assigned to any machine. If not set, return catalogs irrespective if they're assigned to a machine or not."},"description":"If true, only return catalogs that are not assigned to any machine. If not set, return catalogs irrespective if they're assigned to a machine or not."},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/DowntimeCatalogState"},{"type":"null"}],"title":"Filter by lifecycle state.","description":"If not set, both active and archived catalogs will be returned."},"description":"If not set, both active and archived catalogs will be returned."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDowntimeCatalogs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Create Downtime Catalog

> Create a downtime catalog.

```json
{"openapi":"3.1.0","info":{"title":"ENLYZE API","version":"v2"},"tags":[{"name":"Downtime Catalogs","description":"⚠️ **Experimental** — this resource is under active development and may change without notice."}],"servers":[{"url":"/api"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"CreateDowntimeCatalog":{"properties":{"name":{"type":"string","minLength":1,"title":"Downtime Catalog Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Downtime Catalog Description","description":"Free-text description of the downtime catalog."}},"type":"object","required":["name"],"title":"CreateDowntimeCatalog"},"DowntimeCatalog":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Downtime Catalog UUID","description":"The UUID of the downtime catalog."},"name":{"type":"string","title":"Name","description":"Name of the downtime catalog."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Free-text description of the downtime catalog."},"state":{"$ref":"#/components/schemas/DowntimeCatalogState","title":"State","description":"Lifecycle state of the downtime catalog."}},"type":"object","required":["uuid","name","state"],"title":"DowntimeCatalog"},"DowntimeCatalogState":{"type":"string","enum":["active","archived"],"title":"DowntimeCatalogState"},"CatalogNameCollisionError":{"properties":{"type":{"type":"string","const":"name_collision","title":"Type","default":"name_collision"},"conflict":{"$ref":"#/components/schemas/ConflictingCatalog","title":"Conflicting Catalog","description":"The catalog already holding the name; when its `state` is `archived`, restoring it is an alternative to creating a new one."}},"type":"object","required":["conflict"],"title":"CatalogNameCollisionError"},"ConflictingCatalog":{"properties":{"catalog":{"type":"string","format":"uuid","title":"Conflicting Catalog UUID"},"state":{"$ref":"#/components/schemas/DowntimeCatalogState","title":"Conflicting Catalog State","description":"Lifecycle state of the conflicting catalog."}},"type":"object","required":["catalog","state"],"title":"ConflictingCatalog"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v2/downtime-catalogs":{"post":{"tags":["Downtime Catalogs"],"summary":"Create Downtime Catalog","description":"Create a downtime catalog.","operationId":"create_downtime_catalog_v2_downtime_catalogs_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDowntimeCatalog"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DowntimeCatalog"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CatalogNameCollisionError"}],"discriminator":{"propertyName":"type","mapping":{"name_collision":"#/components/schemas/CatalogNameCollisionError"}},"title":"Response 409 Create Downtime Catalog V2 Downtime Catalogs Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Get Downtime Catalog

> Returns details for a specific downtime catalog.

```json
{"openapi":"3.1.0","info":{"title":"ENLYZE API","version":"v2"},"tags":[{"name":"Downtime Catalogs","description":"⚠️ **Experimental** — this resource is under active development and may change without notice."}],"servers":[{"url":"/api"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DowntimeCatalog":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Downtime Catalog UUID","description":"The UUID of the downtime catalog."},"name":{"type":"string","title":"Name","description":"Name of the downtime catalog."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Free-text description of the downtime catalog."},"state":{"$ref":"#/components/schemas/DowntimeCatalogState","title":"State","description":"Lifecycle state of the downtime catalog."}},"type":"object","required":["uuid","name","state"],"title":"DowntimeCatalog"},"DowntimeCatalogState":{"type":"string","enum":["active","archived"],"title":"DowntimeCatalogState"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v2/downtime-catalogs/{uuid}":{"get":{"tags":["Downtime Catalogs"],"summary":"Get Downtime Catalog","description":"Returns details for a specific downtime catalog.","operationId":"get_downtime_catalog_v2_downtime_catalogs__uuid__get","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The UUID of the downtime catalog."}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DowntimeCatalog"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Delete Downtime Catalog

> Delete a downtime catalog and all of its reasons (both active and archived). Downtimes labeled with those reasons are kept, but lose their reason. Any machine assignments of the catalog are removed. Works on active and archived catalogs. Pass \`dry\_run=true\` to see how many reasons and downtimes would be affected, without deleting anything.

```json
{"openapi":"3.1.0","info":{"title":"ENLYZE API","version":"v2"},"tags":[{"name":"Downtime Catalogs","description":"⚠️ **Experimental** — this resource is under active development and may change without notice."}],"servers":[{"url":"/api"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DowntimeCatalogDeleteResult":{"properties":{"deleted_reasons":{"type":"integer","title":"Deleted Reasons","description":"Number of downtime reasons deleted along with the catalog (a dry run reports how many would be deleted)."},"unlabeled_downtimes":{"type":"integer","title":"Unlabeled Downtimes","description":"Number of downtimes that lose their reason; the downtimes themselves are kept (a dry run reports how many would be unlabeled)."}},"type":"object","required":["deleted_reasons","unlabeled_downtimes"],"title":"DowntimeCatalogDeleteResult"},"CatalogNotFoundError":{"properties":{"type":{"type":"string","const":"catalog_not_found","title":"Type","default":"catalog_not_found"}},"type":"object","title":"CatalogNotFoundError"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v2/downtime-catalogs/{uuid}":{"delete":{"tags":["Downtime Catalogs"],"summary":"Delete Downtime Catalog","description":"Delete a downtime catalog and all of its reasons (both active and archived). Downtimes labeled with those reasons are kept, but lose their reason. Any machine assignments of the catalog are removed. Works on active and archived catalogs. Pass `dry_run=true` to see how many reasons and downtimes would be affected, without deleting anything.","operationId":"delete_downtime_catalog_v2_downtime_catalogs__uuid__delete","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The UUID of the downtime catalog."}},{"name":"dry_run","in":"query","required":false,"schema":{"type":"boolean","title":"Preview the delete without applying it.","description":"If true, nothing is deleted; the response reports what a real delete would affect.","default":false},"description":"If true, nothing is deleted; the response reports what a real delete would affect."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DowntimeCatalogDeleteResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CatalogNotFoundError"}],"discriminator":{"propertyName":"type","mapping":{"catalog_not_found":"#/components/schemas/CatalogNotFoundError"}},"title":"Response 404 Delete Downtime Catalog V2 Downtime Catalogs  Uuid  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Update Downtime Catalog

> Update a downtime catalog's name or description.

```json
{"openapi":"3.1.0","info":{"title":"ENLYZE API","version":"v2"},"tags":[{"name":"Downtime Catalogs","description":"⚠️ **Experimental** — this resource is under active development and may change without notice."}],"servers":[{"url":"/api"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"UpdateDowntimeCatalog":{"properties":{"name":{"type":"string","minLength":1,"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","title":"UpdateDowntimeCatalog"},"DowntimeCatalog":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Downtime Catalog UUID","description":"The UUID of the downtime catalog."},"name":{"type":"string","title":"Name","description":"Name of the downtime catalog."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Free-text description of the downtime catalog."},"state":{"$ref":"#/components/schemas/DowntimeCatalogState","title":"State","description":"Lifecycle state of the downtime catalog."}},"type":"object","required":["uuid","name","state"],"title":"DowntimeCatalog"},"DowntimeCatalogState":{"type":"string","enum":["active","archived"],"title":"DowntimeCatalogState"},"CatalogNotFoundError":{"properties":{"type":{"type":"string","const":"catalog_not_found","title":"Type","default":"catalog_not_found"}},"type":"object","title":"CatalogNotFoundError"},"CatalogArchivedError":{"properties":{"type":{"type":"string","const":"archived_catalog","title":"Type","default":"archived_catalog"}},"type":"object","title":"CatalogArchivedError"},"CatalogNameCollisionError":{"properties":{"type":{"type":"string","const":"name_collision","title":"Type","default":"name_collision"},"conflict":{"$ref":"#/components/schemas/ConflictingCatalog","title":"Conflicting Catalog","description":"The catalog already holding the name; when its `state` is `archived`, restoring it is an alternative to creating a new one."}},"type":"object","required":["conflict"],"title":"CatalogNameCollisionError"},"ConflictingCatalog":{"properties":{"catalog":{"type":"string","format":"uuid","title":"Conflicting Catalog UUID"},"state":{"$ref":"#/components/schemas/DowntimeCatalogState","title":"Conflicting Catalog State","description":"Lifecycle state of the conflicting catalog."}},"type":"object","required":["catalog","state"],"title":"ConflictingCatalog"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v2/downtime-catalogs/{uuid}":{"patch":{"tags":["Downtime Catalogs"],"summary":"Update Downtime Catalog","description":"Update a downtime catalog's name or description.","operationId":"update_downtime_catalog_v2_downtime_catalogs__uuid__patch","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The UUID of the downtime catalog."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDowntimeCatalog"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DowntimeCatalog"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CatalogNotFoundError"}],"discriminator":{"propertyName":"type","mapping":{"catalog_not_found":"#/components/schemas/CatalogNotFoundError"}},"title":"Response 404 Update Downtime Catalog V2 Downtime Catalogs  Uuid  Patch"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CatalogArchivedError"},{"$ref":"#/components/schemas/CatalogNameCollisionError"}],"discriminator":{"propertyName":"type","mapping":{"archived_catalog":"#/components/schemas/CatalogArchivedError","name_collision":"#/components/schemas/CatalogNameCollisionError"}},"title":"Response 409 Update Downtime Catalog V2 Downtime Catalogs  Uuid  Patch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Set Downtime Catalog State

> Archive or restore a downtime catalog. Archiving cascades the state to all of the catalog's reasons; both directions are reversible. Setting the state the catalog is already in is a no-op.

```json
{"openapi":"3.1.0","info":{"title":"ENLYZE API","version":"v2"},"tags":[{"name":"Downtime Catalogs","description":"⚠️ **Experimental** — this resource is under active development and may change without notice."}],"servers":[{"url":"/api"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"UpdateDowntimeCatalogStateRequest":{"properties":{"state":{"$ref":"#/components/schemas/DowntimeCatalogState","title":"Downtime Catalog State","description":"Lifecycle state to transition the catalog to."}},"type":"object","required":["state"],"title":"UpdateDowntimeCatalogStateRequest"},"DowntimeCatalogState":{"type":"string","enum":["active","archived"],"title":"DowntimeCatalogState"},"DowntimeCatalog":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Downtime Catalog UUID","description":"The UUID of the downtime catalog."},"name":{"type":"string","title":"Name","description":"Name of the downtime catalog."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Free-text description of the downtime catalog."},"state":{"$ref":"#/components/schemas/DowntimeCatalogState","title":"State","description":"Lifecycle state of the downtime catalog."}},"type":"object","required":["uuid","name","state"],"title":"DowntimeCatalog"},"CatalogNotFoundError":{"properties":{"type":{"type":"string","const":"catalog_not_found","title":"Type","default":"catalog_not_found"}},"type":"object","title":"CatalogNotFoundError"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v2/downtime-catalogs/{uuid}/state":{"put":{"tags":["Downtime Catalogs"],"summary":"Set Downtime Catalog State","description":"Archive or restore a downtime catalog. Archiving cascades the state to all of the catalog's reasons; both directions are reversible. Setting the state the catalog is already in is a no-op.","operationId":"set_downtime_catalog_state_v2_downtime_catalogs__uuid__state_put","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The UUID of the downtime catalog."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDowntimeCatalogStateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DowntimeCatalog"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CatalogNotFoundError"}],"discriminator":{"propertyName":"type","mapping":{"catalog_not_found":"#/components/schemas/CatalogNotFoundError"}},"title":"Response 404 Set Downtime Catalog State V2 Downtime Catalogs  Uuid  State Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Assign Downtime Catalog To Machine

> Assign this downtime catalog to the specified machine.

```json
{"openapi":"3.1.0","info":{"title":"ENLYZE API","version":"v2"},"tags":[{"name":"Downtime Catalogs","description":"⚠️ **Experimental** — this resource is under active development and may change without notice."}],"servers":[{"url":"/api"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"AssignMachineRequest":{"properties":{},"type":"object","title":"AssignMachineRequest"},"CatalogNotFoundError":{"properties":{"type":{"type":"string","const":"catalog_not_found","title":"Type","default":"catalog_not_found"}},"type":"object","title":"CatalogNotFoundError"},"MachineNotFoundError":{"properties":{"type":{"type":"string","const":"machine_not_found","title":"Type","default":"machine_not_found"}},"type":"object","title":"MachineNotFoundError"},"CatalogArchivedError":{"properties":{"type":{"type":"string","const":"archived_catalog","title":"Type","default":"archived_catalog"}},"type":"object","title":"CatalogArchivedError"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v2/downtime-catalogs/{uuid}/machines/{machine_uuid}":{"post":{"tags":["Downtime Catalogs"],"summary":"Assign Downtime Catalog To Machine","description":"Assign this downtime catalog to the specified machine.","operationId":"assign_downtime_catalog_to_machine_v2_downtime_catalogs__uuid__machines__machine_uuid__post","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The UUID of the downtime catalog."}},{"name":"machine_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The UUID of the machine."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignMachineRequest"}}}},"responses":{"204":{"description":"Successful Response"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CatalogNotFoundError"},{"$ref":"#/components/schemas/MachineNotFoundError"}],"discriminator":{"propertyName":"type","mapping":{"catalog_not_found":"#/components/schemas/CatalogNotFoundError","machine_not_found":"#/components/schemas/MachineNotFoundError"}},"title":"Response 404 Assign Downtime Catalog To Machine V2 Downtime Catalogs  Uuid  Machines  Machine Uuid  Post"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CatalogArchivedError"}],"discriminator":{"propertyName":"type","mapping":{"archived_catalog":"#/components/schemas/CatalogArchivedError"}},"title":"Response 409 Assign Downtime Catalog To Machine V2 Downtime Catalogs  Uuid  Machines  Machine Uuid  Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Unassign Downtime Catalog From Machine

> Unassign this downtime catalog from the specified machine.

```json
{"openapi":"3.1.0","info":{"title":"ENLYZE API","version":"v2"},"tags":[{"name":"Downtime Catalogs","description":"⚠️ **Experimental** — this resource is under active development and may change without notice."}],"servers":[{"url":"/api"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"CatalogNotFoundError":{"properties":{"type":{"type":"string","const":"catalog_not_found","title":"Type","default":"catalog_not_found"}},"type":"object","title":"CatalogNotFoundError"},"MachineNotFoundError":{"properties":{"type":{"type":"string","const":"machine_not_found","title":"Type","default":"machine_not_found"}},"type":"object","title":"MachineNotFoundError"},"CatalogArchivedError":{"properties":{"type":{"type":"string","const":"archived_catalog","title":"Type","default":"archived_catalog"}},"type":"object","title":"CatalogArchivedError"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v2/downtime-catalogs/{uuid}/machines/{machine_uuid}":{"delete":{"tags":["Downtime Catalogs"],"summary":"Unassign Downtime Catalog From Machine","description":"Unassign this downtime catalog from the specified machine.","operationId":"unassign_downtime_catalog_from_machine_v2_downtime_catalogs__uuid__machines__machine_uuid__delete","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The UUID of the downtime catalog."}},{"name":"machine_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The UUID of the machine."}}],"responses":{"204":{"description":"Successful Response"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CatalogNotFoundError"},{"$ref":"#/components/schemas/MachineNotFoundError"}],"discriminator":{"propertyName":"type","mapping":{"catalog_not_found":"#/components/schemas/CatalogNotFoundError","machine_not_found":"#/components/schemas/MachineNotFoundError"}},"title":"Response 404 Unassign Downtime Catalog From Machine V2 Downtime Catalogs  Uuid  Machines  Machine Uuid  Delete"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CatalogArchivedError"}],"discriminator":{"propertyName":"type","mapping":{"archived_catalog":"#/components/schemas/CatalogArchivedError"}},"title":"Response 409 Unassign Downtime Catalog From Machine V2 Downtime Catalogs  Uuid  Machines  Machine Uuid  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## List Machines For Catalog

> List the machines this downtime catalog is assigned to.

```json
{"openapi":"3.1.0","info":{"title":"ENLYZE API","version":"v2"},"tags":[{"name":"Downtime Catalogs","description":"⚠️ **Experimental** — this resource is under active development and may change without notice."}],"servers":[{"url":"/api"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"PaginatedMachineRefs":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MachineRef"},"type":"array","title":"Data"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"This field contains pagination metadata."}},"additionalProperties":false,"type":"object","required":["data","metadata"],"title":"PaginatedMachineRefs"},"MachineRef":{"properties":{"machine":{"type":"string","format":"uuid","title":"Machine UUID","description":"The UUID of a machine assigned to the downtime catalog."}},"type":"object","required":["machine"],"title":"MachineRef"},"Metadata":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"Pagination continuation point. Specify its value as the `cursor` parameter in a request with otherwise the same parameters to fetch the next page. `None`, if there is no more data to be fetched from the server."}},"additionalProperties":false,"type":"object","required":["next_cursor"],"title":"Metadata"},"CatalogNotFoundError":{"properties":{"type":{"type":"string","const":"catalog_not_found","title":"Type","default":"catalog_not_found"}},"type":"object","title":"CatalogNotFoundError"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v2/downtime-catalogs/{uuid}/machines":{"get":{"tags":["Downtime Catalogs"],"summary":"List Machines For Catalog","description":"List the machines this downtime catalog is assigned to.","operationId":"list_machines_for_catalog_v2_downtime_catalogs__uuid__machines_get","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The UUID of the downtime catalog."}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","title":"Get page starting at cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"title":"Maximum number of results to return","description":"Caps the page size. Defaults to 1000, which is also the maximum; a value below 1 or above 1000 is rejected.","default":1000},"description":"Caps the page size. Defaults to 1000, which is also the maximum; a value below 1 or above 1000 is rejected."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedMachineRefs"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CatalogNotFoundError"}],"discriminator":{"propertyName":"type","mapping":{"catalog_not_found":"#/components/schemas/CatalogNotFoundError"}},"title":"Response 404 List Machines For Catalog V2 Downtime Catalogs  Uuid  Machines Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```