{"openapi":"3.1.0","info":{"title":"XenData HTTP Gateway","description":"HTTP/JSON gateway for XenData Workflow API XML-over-TCP requests. Configure the XenData TCP destination with XENDATA_HOST and XENDATA_PORT. The raw endpoint is an escape hatch for documented commands/options not modelled by a typed endpoint.","version":"1.0.0"},"paths":{"/healthz":{"get":{"tags":["Operations"],"summary":"Healthz","operationId":"healthz_healthz_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Healthz Healthz Get"}}}}}}},"/api/v1/system-status":{"get":{"tags":["System"],"summary":"System Status","operationId":"system_status_api_v1_system_status_get","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/archive":{"post":{"tags":["Transfer"],"summary":"Archive","operationId":"archive_api_v1_archive_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/move":{"post":{"tags":["Transfer"],"summary":"Move","operationId":"move_api_v1_move_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/restore":{"post":{"tags":["Transfer"],"summary":"Restore","operationId":"restore_api_v1_restore_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/delete":{"post":{"tags":["Destructive"],"summary":"Delete","operationId":"delete_api_v1_delete_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/list-objects":{"post":{"tags":["Archive browsing"],"summary":"List Objects","operationId":"list_objects_api_v1_list_objects_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListObjectsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/search-objects":{"post":{"tags":["Archive browsing"],"summary":"Search Objects","operationId":"search_objects_api_v1_search_objects_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchObjectsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/object-exists":{"post":{"tags":["Archive browsing"],"summary":"Object Exists","operationId":"object_exists_api_v1_object_exists_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectReferenceRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/object-location":{"post":{"tags":["Archive browsing"],"summary":"Object Location","operationId":"object_location_api_v1_object_location_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectReferenceRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/list-jobs":{"post":{"tags":["Jobs"],"summary":"List Jobs","operationId":"list_jobs_api_v1_list_jobs_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListJobsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/jobs/{job_id}":{"get":{"tags":["Jobs"],"summary":"Get Status","operationId":"get_status_api_v1_jobs__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/jobs/{job_id}/cancel":{"post":{"tags":["Destructive"],"summary":"Cancel Job","operationId":"cancel_job_api_v1_jobs__job_id__cancel_post","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/list-file-groups":{"post":{"tags":["Configuration"],"summary":"List File Groups","operationId":"list_file_groups_api_v1_list_file_groups_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileGroupRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/list-volume-sets":{"post":{"tags":["Configuration"],"summary":"List Volume Sets","operationId":"list_volume_sets_api_v1_list_volume_sets_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumeSetRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/raw":{"post":{"tags":["Advanced"],"summary":"Raw Xml","description":"Send an explicitly supplied <Request> document. Intended for documented advanced options.","operationId":"raw_xml_api_v1_raw_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RawXmlRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DeleteRequest":{"properties":{"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority"},"archive_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive Path"},"asset_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Name"},"archive_guid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive Guid"}},"additionalProperties":false,"type":"object","title":"DeleteRequest"},"FileGroupRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","title":"Names"}},"additionalProperties":false,"type":"object","title":"FileGroupRequest"},"FileHash":{"properties":{"algorithm":{"type":"string","enum":["MD2","MD4","MD5","SHA","SHA1","SHA256","SHA384","SHA512"],"title":"Algorithm"},"hash":{"type":"string","title":"Hash"},"file_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Name"}},"additionalProperties":false,"type":"object","required":["algorithm","hash"],"title":"FileHash"},"GatewayResponse":{"properties":{"xml":{"type":"string","title":"Xml"},"parsed":{"additionalProperties":true,"type":"object","title":"Parsed"}},"type":"object","required":["xml","parsed"],"title":"GatewayResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ListJobsRequest":{"properties":{"objects_per_request":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Objects Per Request"}},"additionalProperties":false,"type":"object","title":"ListJobsRequest"},"ListObjectsRequest":{"properties":{"archive_path":{"type":"string","title":"Archive Path","default":""},"objects_per_request":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Objects Per Request"}},"additionalProperties":false,"type":"object","title":"ListObjectsRequest"},"MetadataColumn":{"properties":{"name":{"type":"string","title":"Name"},"select":{"type":"string","title":"Select"}},"additionalProperties":false,"type":"object","required":["name","select"],"title":"MetadataColumn"},"ObjectReferenceRequest":{"properties":{"archive_path":{"type":"string","title":"Archive Path"},"asset_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Name"},"archive_guid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive Guid"}},"additionalProperties":false,"type":"object","required":["archive_path"],"title":"ObjectReferenceRequest"},"PartialRequest":{"properties":{"time_in":{"type":"string","title":"Time In"},"time_out":{"type":"string","title":"Time Out"}},"additionalProperties":false,"type":"object","required":["time_in","time_out"],"title":"PartialRequest"},"RawXmlRequest":{"properties":{"xml":{"type":"string","minLength":1,"title":"Xml"}},"additionalProperties":false,"type":"object","required":["xml"],"title":"RawXmlRequest"},"RemoteObject":{"properties":{"file_urls":{"items":{"type":"string"},"type":"array","minItems":1,"title":"File Urls"},"archive_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive Path"},"archive_guid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive Guid"},"search_metadata":{"items":{"$ref":"#/components/schemas/MetadataColumn"},"type":"array","title":"Search Metadata"},"file_hashes":{"items":{"$ref":"#/components/schemas/FileHash"},"type":"array","title":"File Hashes"},"partial":{"items":{"$ref":"#/components/schemas/PartialRequest"},"type":"array","title":"Partial"}},"additionalProperties":false,"type":"object","required":["file_urls"],"title":"RemoteObject"},"SearchObjectsRequest":{"properties":{"query":{"type":"string","title":"Query"},"columns":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Columns"},"objects_per_request":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Objects Per Request"},"objects_start_index":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Objects Start Index"},"objects_max_count":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Objects Max Count"}},"additionalProperties":false,"type":"object","required":["query","columns"],"title":"SearchObjectsRequest"},"TransferRequest":{"properties":{"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority"},"archive_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive Path"},"archive_file_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive File Name"},"server_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Server Id"},"asset_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Name"},"file_names":{"items":{"type":"string"},"type":"array","title":"File Names"},"server_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Server Path"},"server_file_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Server File Name"},"archive_guid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive Guid"},"search_metadata":{"items":{"$ref":"#/components/schemas/MetadataColumn"},"type":"array","title":"Search Metadata"},"assets":{"items":{"$ref":"#/components/schemas/RemoteObject"},"type":"array","title":"Assets"},"files":{"items":{"$ref":"#/components/schemas/RemoteObject"},"type":"array","title":"Files"},"file_hashes":{"items":{"$ref":"#/components/schemas/FileHash"},"type":"array","title":"File Hashes"},"partial":{"items":{"$ref":"#/components/schemas/PartialRequest"},"type":"array","title":"Partial"},"status_callbacks":{"items":{"type":"string"},"type":"array","title":"Status Callbacks"}},"additionalProperties":false,"type":"object","title":"TransferRequest"},"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"},"VolumeSetReference":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},"additionalProperties":false,"type":"object","title":"VolumeSetReference"},"VolumeSetRequest":{"properties":{"volume_sets":{"items":{"$ref":"#/components/schemas/VolumeSetReference"},"type":"array","title":"Volume Sets"}},"additionalProperties":false,"type":"object","title":"VolumeSetRequest"}}}}