{"openapi":"3.1.0","info":{"title":"ALCF implementation of the IRI Facility API","description":"[Click here](https://docs.alcf.anl.gov/services/iri-api/) for authentication and usage examples.\n\nThe ALCF IRI API is available to all ALCF users.\n\n<img src=\"https://iri.science/images/doe-icon-old.png\" height=50 />","termsOfService":"https://docs.alcf.anl.gov/policies/","contact":{"name":"ALCF","url":"https://www.alcf.anl.gov/"},"version":"1.0.0"},"servers":[{"url":"https://api.alcf.anl.gov"}],"paths":{"/api/v1/facility":{"get":{"tags":["facility"],"summary":"Get Facility","description":"Get facility information","operationId":"getFacility","parameters":[{"name":"modified_since","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"Modified Since"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Facility"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/facility/sites":{"get":{"tags":["facility"],"summary":"List Sites","description":"List sites","operationId":"getSites","parameters":[{"name":"modified_since","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"Modified Since"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Name"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":0,"default":100,"title":"Limit"}},{"name":"short_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Short Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Site"},"title":"Response Getsites"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/facility/sites/{site_id}":{"get":{"tags":["facility"],"summary":"Get Site","description":"Get site by ID","operationId":"getSite","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","title":"Site Id"}},{"name":"modified_since","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"Modified Since"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/status/resources":{"get":{"tags":["status"],"summary":"Get all resources","description":"Get a list of all resources at this facility. You can optionally filter the returned list by specifying attribtes.","operationId":"getResources","parameters":[{"name":"name","in":"query","required":false,"schema":{"type":"string","minLength":1,"title":"Name"}},{"name":"description","in":"query","required":false,"schema":{"type":"string","minLength":1,"title":"Description"}},{"name":"group","in":"query","required":false,"schema":{"type":"string","minLength":1,"title":"Group"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":0,"default":100,"title":"Limit"}},{"name":"modified_since","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"Modified Since"}},{"name":"resource_type","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ResourceType"}},{"name":"current_status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Status"}},{"name":"capability","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/AllocationUnit"},"minItems":1,"title":"Capability"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Resource"},"title":"Response Getresources"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/status/resources/{resource_id}":{"get":{"tags":["status"],"summary":"Get a specific resource","description":"Get a specific resource for a given id","operationId":"getResource","parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/status/incidents":{"get":{"tags":["status"],"summary":"Get all incidents without their events","description":"Get a list of all incidents. Each incident will be returned without its events.  You can optionally filter the returned list by specifying attributes.","operationId":"getIncidents","parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Name"}},{"name":"description","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Description"}},{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Status"}},{"name":"type","in":"query","required":false,"schema":{"$ref":"#/components/schemas/IncidentType"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"From"}},{"name":"time","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"Time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"To"}},{"name":"modified_since","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"Modified Since"}},{"name":"resource_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Resource Id"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":0,"default":100,"title":"Limit"}},{"name":"resolution","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Resolution"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Incident"},"title":"Response Getincidents"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/status/incidents/{incident_id}":{"get":{"tags":["status"],"summary":"Get a specific incident and its events","description":"Get a specific incident for a given id. The incident's events will also be included.  You can optionally filter the returned list by specifying attributes.","operationId":"getIncident","parameters":[{"name":"incident_id","in":"path","required":true,"schema":{"type":"string","title":"Incident Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Incident"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/status/events":{"get":{"tags":["status"],"summary":"Get all events","description":"Get a list of all events.  You can optionally filter the returned list by specifying attribtes.","operationId":"getEventsByIncident","parameters":[{"name":"incident_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Incident Id"}},{"name":"resource_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Resource Id"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Name"}},{"name":"description","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Description"}},{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Status"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"From"}},{"name":"time","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"Time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"To"}},{"name":"modified_since","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"Modified Since"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":0,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"title":"Response Geteventsbyincident"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/status/events/{event_id}":{"get":{"tags":["status"],"summary":"Get a specific event","description":"Get a specific event for a given id","operationId":"getEventByIncident","parameters":[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/account/capabilities":{"get":{"tags":["account"],"summary":"Get the list of capabilities","description":"Get a list of capabilities at this facility.","operationId":"getCapabilities","parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Name"}},{"name":"modified_since","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"Modified Since"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":0,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Capability"},"title":"Response Getcapabilities"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/account/capabilities/{capability_id}":{"get":{"tags":["account"],"summary":"Get a single capability","description":"Get a single capability at this facility.","operationId":"getCapability","parameters":[{"name":"capability_id","in":"path","required":true,"schema":{"type":"string","title":"Capability Id"}},{"name":"modified_since","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z","title":"Modified Since"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Capability"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/account/projects":{"get":{"tags":["account"],"summary":"Get the projects of the current user","description":"Get a list of projects for the currently authenticated user at this facility.","operationId":"getProjects","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Project"},"type":"array","title":"Response Getprojects"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"security":[{"HTTPBearer":[]}],"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/account/projects/{project_id}":{"get":{"tags":["account"],"summary":"Get a single project","description":"Get a single project at this facility.","operationId":"getProject","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","title":"Project Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/account/projects/{project_id}/project_allocations":{"get":{"tags":["account"],"summary":"Get the allocations of the current user's projects","description":"Get a list of allocations for the currently authenticated user's projects at this facility.","operationId":"getProjectAllocationsByProject","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","title":"Project Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectAllocation"},"title":"Response Getprojectallocationsbyproject"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/account/projects/{project_id}/project_allocations/{project_allocation_id}":{"get":{"tags":["account"],"summary":"Get a single project allocation","description":"Get a single project allocation at this facility for this user.","operationId":"getProjectAllocationByProject","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","title":"Project Id"}},{"name":"project_allocation_id","in":"path","required":true,"schema":{"type":"string","title":"Project Allocation Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectAllocation"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/account/projects/{project_id}/project_allocations/{project_allocation_id}/user_allocations":{"get":{"tags":["account"],"summary":"Get the user allocations of the current user's projects","description":"Get a list of user allocations for the currently authenticated user's projects at this facility.","operationId":"getUserAllocationsByProjectAllocation","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","title":"Project Id"}},{"name":"project_allocation_id","in":"path","required":true,"schema":{"type":"string","title":"Project Allocation Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserAllocation"},"title":"Response Getuserallocationsbyprojectallocation"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/account/projects/{project_id}/project_allocations/{project_allocation_id}/user_allocations/{user_allocation_id}":{"get":{"tags":["account"],"summary":"Get a user allocation of the current user's projects","description":"Get a user allocation for the currently authenticated user's projects at this facility.","operationId":"getUserAllocationByProjectAllocation","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","title":"Project Id"}},{"name":"project_allocation_id","in":"path","required":true,"schema":{"type":"string","title":"Project Allocation Id"}},{"name":"user_allocation_id","in":"path","required":true,"schema":{"type":"string","title":"User Allocation Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAllocation"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/compute/job/{resource_id}":{"post":{"tags":["compute"],"summary":"Submit Job","description":"Submit a job on a compute resource\n\n- **resource**: the name of the compute resource to use\n- **job_request**: a PSIJ job spec as defined <a href=\"https://exaworks.org/psij-python/docs/v/0.9.11/.generated/tree.html#jobspec\">here</a>\n\nThis command will attempt to submit a job and return its id.","operationId":"launchJob","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSpec-Input"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/compute/job/{resource_id}/{job_id}":{"put":{"tags":["compute"],"summary":"Update Job","description":"Update a previously submitted job for a resource.\nNote that only some attributes of a scheduled job can be updated. Check the facility documentation for details.\n\n- **resource**: the name of the compute resource to use\n- **job_request**: a PSIJ job spec as defined <a href=\"https://exaworks.org/psij-python/docs/v/0.9.11/.generated/tree.html#jobspec\">here</a>","operationId":"updateJob","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSpec-Input"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/compute/status/{resource_id}/{job_id}":{"get":{"tags":["compute"],"summary":"Get Job Status","description":"Get a job's status","operationId":"getJob","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"historical","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean","description":"Strict boolean. Only true/false allowed (bool or string).","example":true},{"type":"null"}],"description":"Whether to include historical jobs. Defaults to true","default":true,"title":"Historical"},"description":"Whether to include historical jobs. Defaults to true"},{"name":"include_spec","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean","description":"Strict boolean. Only true/false allowed (bool or string).","example":true},{"type":"null"}],"description":"Whether to include the job specification. Defaults to false","default":false,"title":"Include Spec"},"description":"Whether to include the job specification. Defaults to false"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/compute/status/{resource_id}":{"post":{"tags":["compute"],"summary":"Get Job Statuses","description":"Get multiple jobs' statuses","operationId":"getJobs","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":0,"default":100,"title":"Limit"}},{"name":"historical","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean","description":"Strict boolean. Only true/false allowed (bool or string).","example":true},{"type":"null"}],"description":"Whether to include historical jobs. Defaults to false","default":false,"title":"Historical"},"description":"Whether to include historical jobs. Defaults to false"},{"name":"include_spec","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean","description":"Strict boolean. Only true/false allowed (bool or string).","example":true},{"type":"null"}],"description":"Whether to include the job specification. Defaults to false","default":false,"title":"Include Spec"},"description":"Whether to include the job specification. Defaults to false"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"type":"object","additionalProperties":true},{"type":"null"}],"title":"Filters"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Job"},"title":"Response Getjobs"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/compute/cancel/{resource_id}/{job_id}":{"delete":{"tags":["compute"],"summary":"Cancel Job","description":"Cancel a job","operationId":"cancelJob","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"204":{"description":"Successful Response"},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/chmod/{resource_id}":{"put":{"tags":["filesystem"],"summary":"Put Chmod","description":"Change the permission mode of a file(`chmod`)","operationId":"chmod","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutFileChmodRequest"}}}},"responses":{"200":{"description":"File permissions changed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/chown/{resource_id}":{"put":{"tags":["filesystem"],"summary":"Put Chown","description":"Change the ownership of a given file (`chown`)","operationId":"chown","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutFileChownRequest"}}}},"responses":{"200":{"description":"File ownership changed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/file/{resource_id}":{"get":{"tags":["filesystem"],"summary":"Get File","description":"Output the type of a file or directory","operationId":"file","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","description":"A file or folder path","title":"Path"},"description":"A file or folder path"}],"responses":{"200":{"description":"Type returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/stat/{resource_id}":{"get":{"tags":["filesystem"],"summary":"Get Stat","description":"Output the `stat` of a file","operationId":"stat","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","description":"A file or folder path","title":"Path"},"description":"A file or folder path"},{"name":"dereference","in":"query","required":false,"schema":{"type":"boolean","description":"Follow symbolic links","default":false,"title":"Dereference"},"description":"Follow symbolic links"}],"responses":{"200":{"description":"Stat returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/mkdir/{resource_id}":{"post":{"tags":["filesystem"],"summary":"Post Mkdir","description":"Create directory operation (`mkdir`)","operationId":"mkdir","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostMakeDirRequest"}}}},"responses":{"201":{"description":"Directory created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/symlink/{resource_id}":{"post":{"tags":["filesystem"],"summary":"Post Symlink","description":"Create symlink operation (`ln`)","operationId":"symlink","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostFileSymlinkRequest"}}}},"responses":{"201":{"description":"Symlink created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/ls/{resource_id}":{"get":{"tags":["filesystem"],"summary":"Get Ls Async","description":"List the contents of the given directory (`ls`) asynchronously","operationId":"ls","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","description":"The path to list","title":"Path"},"description":"The path to list"},{"name":"showHidden","in":"query","required":false,"schema":{"type":"boolean","description":"Show hidden files","default":false,"title":"Showhidden"},"description":"Show hidden files"},{"name":"numericUid","in":"query","required":false,"schema":{"type":"boolean","description":"List numeric user and group IDs","default":false,"title":"Numericuid"},"description":"List numeric user and group IDs"},{"name":"recursive","in":"query","required":false,"schema":{"type":"boolean","description":"Recursively list files and folders","default":false,"title":"Recursive"},"description":"Recursively list files and folders"},{"name":"dereference","in":"query","required":false,"schema":{"type":"boolean","description":"Show information for the file the link references.","default":false,"title":"Dereference"},"description":"Show information for the file the link references."}],"responses":{"200":{"description":"Directory listed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/head/{resource_id}":{"get":{"tags":["filesystem"],"summary":"Get Head","description":"Output the first part of file/s (`head`)","operationId":"head","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","description":"File path","title":"Path"},"description":"File path"},{"name":"bytes","in":"query","required":false,"schema":{"type":"integer","description":"The output will be the first NUM bytes of each file.","title":"Bytes"},"description":"The output will be the first NUM bytes of each file."},{"name":"lines","in":"query","required":false,"schema":{"type":"integer","description":"The output will be the first NUM lines of each file.","title":"Lines"},"description":"The output will be the first NUM lines of each file."},{"name":"skipTrailing","in":"query","required":false,"schema":{"type":"boolean","description":"The output will be the whole file, without the last NUM bytes/lines of each file. NUM should be specified in the respective argument through `bytes` or `lines`.","default":false,"title":"Skiptrailing"},"description":"The output will be the whole file, without the last NUM bytes/lines of each file. NUM should be specified in the respective argument through `bytes` or `lines`."}],"responses":{"200":{"description":"Head operation finished successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/view/{resource_id}":{"get":{"tags":["filesystem"],"summary":"Get View","description":"View file content (up to max 5242880 bytes)","operationId":"view","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","description":"File path","title":"Path"},"description":"File path"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":5242880,"minimum":1,"description":"Value, in bytes, of the size of data to be retrieved from the file.","default":5242880,"title":"Size"},"description":"Value, in bytes, of the size of data to be retrieved from the file."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Value in bytes of the offset.","default":0,"title":"Offset"},"description":"Value in bytes of the offset."}],"responses":{"200":{"description":"View operation finished successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/tail/{resource_id}":{"get":{"tags":["filesystem"],"summary":"Get Tail","description":"Output the last part of a file (`tail`)","operationId":"tail","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","minLength":1,"description":"File path","title":"Path"},"description":"File path"},{"name":"bytes","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The output will be the last NUM bytes of each file.","title":"Bytes"},"description":"The output will be the last NUM bytes of each file."},{"name":"lines","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The output will be the last NUM lines of each file.","title":"Lines"},"description":"The output will be the last NUM lines of each file."},{"name":"skipHeading","in":"query","required":false,"schema":{"type":"boolean","description":"The output will be the whole file, without the first NUM bytes/lines of each file. NUM should be specified in the respective argument through `bytes` or `lines`.","default":false,"title":"Skipheading"},"description":"The output will be the whole file, without the first NUM bytes/lines of each file. NUM should be specified in the respective argument through `bytes` or `lines`."}],"responses":{"200":{"description":"`tail` operation finished successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/checksum/{resource_id}":{"get":{"tags":["filesystem"],"summary":"Get Checksum","description":"Output the checksum of a file (using SHA-256 algotithm)","operationId":"checksum","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","description":"Target system","title":"Path"},"description":"Target system"}],"responses":{"200":{"description":"Checksum returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/rm/{resource_id}":{"delete":{"tags":["filesystem"],"summary":"Delete Rm","description":"Delete file or directory operation (`rm`)","operationId":"rm","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","description":"The path to delete","title":"Path"},"description":"The path to delete"}],"responses":{"200":{"description":"File or directory deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/compress/{resource_id}":{"post":{"tags":["filesystem"],"summary":"Post Compress","description":"Compress files and directories using `tar` command","operationId":"compress","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostCompressRequest"}}}},"responses":{"201":{"description":"File and/or directories compressed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/extract/{resource_id}":{"post":{"tags":["filesystem"],"summary":"Post Extract","description":"Extract `tar` `gzip` archives","operationId":"extract","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostExtractRequest"}}}},"responses":{"201":{"description":"File extracted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/mv/{resource_id}":{"post":{"tags":["filesystem"],"summary":"Move Mv","description":"Create move file or directory operation (`mv`)","operationId":"mv","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostMoveRequest"}}}},"responses":{"201":{"description":"Move file or directory operation created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/cp/{resource_id}":{"post":{"tags":["filesystem"],"summary":"Post Cp","description":"Create copy file or directory operation (`cp`)","operationId":"cp","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostCopyRequest"}}}},"responses":{"201":{"description":"Copy file or directory operation created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/download/{resource_id}":{"get":{"tags":["filesystem"],"summary":"Get Download","description":"Download a small file (max 5242880 Bytes)","operationId":"download","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","description":"A file to download","title":"Path"},"description":"A file to download"}],"responses":{"200":{"description":"File downloaded successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/filesystem/upload/{resource_id}":{"post":{"tags":["filesystem"],"summary":"Post Upload","description":"Upload a small file (max 5242880 Bytes)","operationId":"upload","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","description":"Specify path where file should be uploaded.","title":"Path"},"description":"Specify path where file should be uploaded."}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload"}}}},"responses":{"200":{"description":"File uploaded successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/task/{task_id}":{"get":{"tags":["task"],"summary":"Get Task","description":"Get a task","operationId":"getTask","security":[{"HTTPBearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}},"delete":{"tags":["task"],"summary":"Delete Task","description":"Delete a task","operationId":"deleteTask","security":[{"HTTPBearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Deletetask"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"x-iri":{"maturity":"production","implementation":{"level":"required"}}}},"/api/v1/task":{"get":{"tags":["task"],"summary":"Get Tasks","description":"Get all tasks","operationId":"getTasks","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Task"},"type":"array","title":"Response Gettasks"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Unauthorized","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Method Not Allowed","headers":{"Allow":{"description":"Allowed HTTP methods","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not Modified"}},"security":[{"HTTPBearer":[]}],"x-iri":{"maturity":"production","implementation":{"level":"required"}}}}},"components":{"schemas":{"AllocationEntry":{"properties":{"allocation":{"type":"number","title":"Allocation","description":"Total allocation amount granted.","example":100000.0},"usage":{"type":"number","title":"Usage","description":"Amount of allocation consumed.","example":52342.5},"unit":{"$ref":"#/components/schemas/AllocationUnit","description":"Unit of the allocation (e.g., node_hours, bytes).","example":"node_hours"}},"additionalProperties":true,"type":"object","required":["allocation","usage","unit"],"title":"AllocationEntry","description":"Base class for allocations."},"AllocationUnit":{"type":"string","enum":["node_hours","bytes","inodes"],"title":"AllocationUnit","description":"Units for allocation"},"Body_upload":{"properties":{"file":{"type":"string","format":"binary","title":"File","description":"File to be uploaded as `multipart/form-data`"}},"type":"object","required":["file"],"title":"Body_upload"},"Capability":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier for the object. Typically a UUID or URN.","example":"urn:iri:object:1234"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The long name of the object.","example":"Perlmutter GPU"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Human-readable description of the object.","example":"High-performance GPU compute resource"},"last_modified":{"anyOf":[{"type":"string","format":"date-time","description":"Strict ISO8601 datetime. Only valid ISO8601 datetime strings are accepted.","example":"2026-02-21T12:00:00Z"},{"type":"null"}],"title":"Last Modified","description":"ISO 8601 timestamp when this object was last modified.","example":"2026-02-21T12:00:00Z"},"units":{"items":{"$ref":"#/components/schemas/AllocationUnit"},"type":"array","title":"Units","description":"Allocation units supported by this capability","example":["node_hours"]},"self_uri":{"type":"string","title":"Self Uri","description":"The canonical URL of this object","readOnly":true}},"additionalProperties":true,"type":"object","required":["id","units","self_uri"],"title":"Capability","description":"An aspect of a resource that can have an allocation.\nFor example, Perlmutter nodes with GPUs\nFor some resources at a facility, this will be 1 to 1 with the resource.\nIt is a way to further subdivide a resource into allocatable sub-resources.\nThe word \"capability\" is also known to users as something they need for a job to run. (eg. gpu)"},"CompressionType":{"type":"string","enum":["none","bzip2","gzip","xz"],"title":"CompressionType","description":"Defines the type of compression to be used for compressing or extracting files."},"Container":{"properties":{"image":{"type":"string","minLength":1,"title":"Image","description":"The container image to use (e.g., 'docker.io/library/ubuntu:latest')","example":"docker.io/library/ubuntu:latest"},"volume_mounts":{"items":{"$ref":"#/components/schemas/VolumeMount"},"type":"array","title":"Volume Mounts","description":"List of volume mounts for the container"}},"additionalProperties":true,"type":"object","required":["image"],"title":"Container","description":"Represents a container specification for job execution.\n\nImplementation notes: The value of gpu_cores_per_process in ResourceSpec should be used to determine\nif the container should be run with GPU support. Likewise, the value of launcher in JobSpec should be used\nto determine if the container should be run with MPI support. The container should by default. be run with\nhost networking."},"Event":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier for the object. Typically a UUID or URN.","example":"urn:iri:object:1234"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The long name of the object.","example":"Perlmutter GPU"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Human-readable description of the object.","example":"High-performance GPU compute resource"},"last_modified":{"type":"string","format":"date-time","title":"Last Modified","description":"ISO 8601 timestamp when this object was last modified.","example":"2026-02-21T12:00:00Z"},"occurred_at":{"type":"string","format":"date-time","title":"Occurred At","description":"Timestamp when the event occurred","example":"2026-02-21T12:00:00Z"},"status":{"$ref":"#/components/schemas/Status","description":"Status of the resource at the time of the event","example":"down"},"self_uri":{"type":"string","title":"Self Uri","description":"The canonical URL of this object","readOnly":true},"resource_uri":{"type":"string","title":"Resource Uri","description":"The resource belonging to this event","readOnly":true},"incident_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Incident Uri","description":"The event's incident","readOnly":true}},"additionalProperties":true,"type":"object","required":["id","last_modified","occurred_at","status","self_uri","resource_uri","incident_uri"],"title":"Event","description":"Represents an event that occurred to a resource, which may be part of an incident."},"Facility":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier for the object. Typically a UUID or URN.","example":"urn:iri:object:1234"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The long name of the object.","example":"Perlmutter GPU"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Human-readable description of the object.","example":"High-performance GPU compute resource"},"last_modified":{"type":"string","format":"date-time","title":"Last Modified","description":"ISO 8601 timestamp when this object was last modified.","example":"2026-02-21T12:00:00Z"},"short_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Name","description":"Common or short name of the Facility.","example":"ESnet"},"organization_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organization Name","description":"Operating organization's name.","example":"Energy Sciences Network"},"support_uri":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Support Uri","description":"Link to facility support portal.","example":"https://support.es.net"},"self_uri":{"type":"string","title":"Self Uri","description":"The canonical URL of this object","readOnly":true},"site_uris":{"items":{"type":"string"},"type":"array","title":"Site Uris","description":"URIs of associated Sites.","readOnly":true}},"additionalProperties":true,"type":"object","required":["id","last_modified","self_uri","site_uris"],"title":"Facility","description":"Facility representation, including associated Sites."},"Incident":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier for the object. Typically a UUID or URN.","example":"urn:iri:object:1234"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The long name of the object.","example":"Perlmutter GPU"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Human-readable description of the object.","example":"High-performance GPU compute resource"},"last_modified":{"type":"string","format":"date-time","title":"Last Modified","description":"ISO 8601 timestamp when this object was last modified.","example":"2026-02-21T12:00:00Z"},"status":{"$ref":"#/components/schemas/Status","description":"Current status of the incident","example":"degraded"},"start":{"type":"string","format":"date-time","title":"Start","description":"Incident start time","example":"2026-02-21T12:00:00Z"},"end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End","description":"Incident end time","example":"2026-02-21T14:00:00Z"},"type":{"$ref":"#/components/schemas/IncidentType","description":"Type of incident","example":"planned"},"resolution":{"$ref":"#/components/schemas/Resolution","description":"Resolution status of the incident","example":"pending"},"self_uri":{"type":"string","title":"Self Uri","description":"The canonical URL of this object","readOnly":true},"event_uris":{"items":{"type":"string"},"type":"array","title":"Event Uris","description":"The list of past events in this incident","readOnly":true},"resource_uris":{"items":{"type":"string"},"type":"array","title":"Resource Uris","description":"The list of resources that may be impacted by this incident","readOnly":true}},"additionalProperties":true,"type":"object","required":["id","last_modified","status","start","type","resolution","self_uri","event_uris","resource_uris"],"title":"Incident","description":"Represents an incident that may impact one or more resources."},"IncidentType":{"type":"string","enum":["planned","unplanned","reservation"],"title":"IncidentType","description":"Represents the type of an incident."},"Job":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the job","example":"job-12345"},"status":{"anyOf":[{"$ref":"#/components/schemas/JobStatus"},{"type":"null"}],"description":"Current status of the job"},"job_spec":{"anyOf":[{"$ref":"#/components/schemas/JobSpec-Output"},{"type":"null"}],"description":"Specification used to create the job"}},"additionalProperties":true,"type":"object","required":["id"],"title":"Job","description":"Represents a job in the system."},"JobAttributes":{"properties":{"duration":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Duration","description":"Duration in seconds","examples":[30,60,120]},"queue_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Queue Name","description":"Name of the queue or partition to submit the job to","example":"debug"},"account":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Account","description":"Account or project to charge for resource usage","example":"proj123"},"reservation_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Reservation Id","description":"ID of a reservation to use for the job","example":"resv-42"},"custom_attributes":{"additionalProperties":{"type":"string"},"type":"object","title":"Custom Attributes","description":"Custom scheduler-specific attributes as key-value pairs","example":{"constraint":"gpu"}}},"additionalProperties":true,"type":"object","title":"JobAttributes","description":"Additional attributes and scheduling parameters for a job."},"JobSpec-Input":{"properties":{"executable":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Executable","description":"Path to the executable to run. If container is specified, this will be used as the entrypoint to the container.","example":"/usr/bin/python"},"container":{"anyOf":[{"$ref":"#/components/schemas/Container"},{"type":"null"}],"description":"Container specification for containerized execution"},"arguments":{"items":{"type":"string"},"type":"array","title":"Arguments","description":"Command-line arguments to pass to the executable or container","example":["-n","100"]},"directory":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Directory","description":"Working directory for the job","example":"/home/user/work"},"name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Name","description":"Name of the job","example":"my-job"},"inherit_environment":{"type":"boolean","title":"Inherit Environment","description":"Whether to inherit the environment variables from the submission environment","default":true,"example":true},"environment":{"additionalProperties":{"type":"string"},"type":"object","title":"Environment","description":"Environment variables to set for the job. If container is specified, these will be set inside the container.","example":{"OMP_NUM_THREADS":"4"}},"stdin_path":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Stdin Path","description":"Path to file to use as standard input","example":"/home/user/input.txt"},"stdout_path":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Stdout Path","description":"Path to file to write standard output","example":"/home/user/output.txt"},"stderr_path":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Stderr Path","description":"Path to file to write standard error","example":"/home/user/error.txt"},"resources":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpec"},{"type":"null"}],"description":"Resource requirements for the job"},"attributes":{"anyOf":[{"$ref":"#/components/schemas/JobAttributes"},{"type":"null"}],"description":"Additional job attributes such as duration, queue, and account"},"pre_launch":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Pre Launch","description":"Script or commands to run before launching the job","example":"module load cuda"},"post_launch":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Post Launch","description":"Script or commands to run after the job completes","example":"echo done"},"launcher":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Launcher","description":"Job launcher to use (e.g., 'mpirun', 'srun')","example":"srun"}},"additionalProperties":false,"type":"object","title":"JobSpec","description":"Specification for a job."},"JobSpec-Output":{"properties":{"executable":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Executable","description":"Path to the executable to run. If container is specified, this will be used as the entrypoint to the container.","example":"/usr/bin/python"},"container":{"anyOf":[{"$ref":"#/components/schemas/Container"},{"type":"null"}],"description":"Container specification for containerized execution"},"arguments":{"items":{"type":"string"},"type":"array","title":"Arguments","description":"Command-line arguments to pass to the executable or container","example":["-n","100"]},"directory":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Directory","description":"Working directory for the job","example":"/home/user/work"},"name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Name","description":"Name of the job","example":"my-job"},"inherit_environment":{"type":"boolean","title":"Inherit Environment","description":"Whether to inherit the environment variables from the submission environment","default":true,"example":true},"environment":{"additionalProperties":{"type":"string"},"type":"object","title":"Environment","description":"Environment variables to set for the job. If container is specified, these will be set inside the container.","example":{"OMP_NUM_THREADS":"4"}},"stdin_path":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Stdin Path","description":"Path to file to use as standard input","example":"/home/user/input.txt"},"stdout_path":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Stdout Path","description":"Path to file to write standard output","example":"/home/user/output.txt"},"stderr_path":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Stderr Path","description":"Path to file to write standard error","example":"/home/user/error.txt"},"resources":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpec"},{"type":"null"}],"description":"Resource requirements for the job"},"attributes":{"anyOf":[{"$ref":"#/components/schemas/JobAttributes"},{"type":"null"}],"description":"Additional job attributes such as duration, queue, and account"},"pre_launch":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Pre Launch","description":"Script or commands to run before launching the job","example":"module load cuda"},"post_launch":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Post Launch","description":"Script or commands to run after the job completes","example":"echo done"},"launcher":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Launcher","description":"Job launcher to use (e.g., 'mpirun', 'srun')","example":"srun"}},"additionalProperties":false,"type":"object","title":"JobSpec","description":"Specification for a job."},"JobState":{"type":"string","enum":["new","queued","held","active","completed","failed","canceled"],"title":"JobState","description":"from: https://exaworks.org/psij-python/docs/v/0.9.11/_modules/psij/job_state.html#JobState\n\nAn enumeration holding the possible job states.\n\nThe possible states are: `NEW`, `QUEUED`, `ACTIVE`, `COMPLETED`, `FAILED`, and `CANCELED`."},"JobStatus":{"properties":{"state":{"$ref":"#/components/schemas/JobState","description":"Current state of the job","example":"queued"},"time":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Time","description":"Timestamp associated with the status (seconds since epoch)","example":1708531200.0},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","description":"Human-readable status message","example":"Job is waiting in queue"},"exit_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Exit Code","description":"Process exit code if the job has finished","example":0},"meta_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta Data","description":"Backend-specific metadata associated with the job status"}},"additionalProperties":true,"type":"object","required":["state"],"title":"JobStatus","description":"Represents the status of a job."},"PostCompressRequest":{"properties":{"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"Source file or directory path","example":"/home/user/dir"},"target_path":{"type":"string","title":"Target Path","description":"Path to the compressed file","example":"/home/user/file.tar.gz"},"match_pattern":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Match Pattern","description":"Regex pattern to filter files to compress","example":".*\\.txt$"},"dereference":{"type":"boolean","title":"Dereference","description":"If set to `true`, it follows symbolic links and archive the files they point to instead of the links themselves.","default":false,"example":true},"compression":{"$ref":"#/components/schemas/CompressionType","description":"Defines the type of compression to be used. By default gzip is used.","default":"gzip","example":"gzip"}},"type":"object","required":["target_path"],"title":"PostCompressRequest","description":"Represents a request to compress a file.","examples":[{"compression":"none","dereference":"true","match_pattern":"*./[ab].*\\.txt","source_path":"/home/user/dir","target_path":"/home/user/file.tar.gz"}]},"PostCopyRequest":{"properties":{"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"Source file or directory path","example":"/home/user/dir"},"target_path":{"type":"string","title":"Target Path","description":"Target path of the copy operation","example":"/home/user/dir/file.new"},"dereference":{"type":"boolean","title":"Dereference","description":"If set to `true`, it follows symbolic links and copies the files they point to instead of the links themselves.","default":false,"example":true}},"type":"object","required":["target_path"],"title":"PostCopyRequest","description":"Represents a request to copy a file.","examples":[{"dereference":"true","source_path":"/home/user/dir/file.orig","target_path":"/home/user/dir/file.new"}]},"PostExtractRequest":{"properties":{"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"Source file or directory path","example":"/home/user/dir"},"target_path":{"type":"string","title":"Target Path","description":"Path to the directory where to extract the compressed file","example":"/home/user/dir"},"compression":{"$ref":"#/components/schemas/CompressionType","description":"Defines the type of compression to be used. By default gzip is used.","default":"gzip","example":"gzip"}},"type":"object","required":["target_path"],"title":"PostExtractRequest","description":"Represents a request to extract a compressed file.","examples":[{"compression":"none","source_path":"/home/user/dir/file.tar.gz","target_path":"/home/user/dir"}]},"PostFileSymlinkRequest":{"properties":{"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"Source file or directory path","example":"/home/user/dir"},"link_path":{"type":"string","title":"Link Path","description":"Path to the new symlink","example":"/home/user/newlink"}},"type":"object","required":["link_path"],"title":"PostFileSymlinkRequest","description":"Represents a request to create a symbolic link.","examples":[{"link_path":"/home/user/newlink","path":"/home/user/dir"}]},"PostMakeDirRequest":{"properties":{"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"Source file or directory path","example":"/home/user/dir"},"parent":{"type":"boolean","title":"Parent","description":"If set to `true` creates all its parent directories if they do not already exist","default":false,"example":true}},"type":"object","title":"PostMakeDirRequest","description":"Represents a request to create a directory.","examples":[{"parent":"true","path":"/home/user/dir/newdir"}]},"PostMoveRequest":{"properties":{"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"Source file or directory path","example":"/home/user/dir"},"target_path":{"type":"string","title":"Target Path","description":"Target path of the move operation","example":"/home/user/dir/file.new"}},"type":"object","required":["target_path"],"title":"PostMoveRequest","description":"Represents a request to move a file.","examples":[{"source_path":"/home/user/dir/file.orig","target_path":"/home/user/dir/file.new"}]},"Problem":{"properties":{"type":{"type":"string","format":"uri","title":"Type","description":"A URI reference that identifies the problem type.","default":"about:blank"},"status":{"type":"integer","maximum":599.0,"minimum":100.0,"title":"Status","description":"The HTTP status code for this occurrence.","example":404},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Short human-readable summary.","example":"Not Found"},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail","description":"Human-readable explanation.","example":"Descriptive text."},"instance":{"type":"string","title":"Instance","description":"A URI reference identifying this occurrence.","example":"http://localhost/api/v1/resource/123"}},"additionalProperties":true,"type":"object","required":["type","status","instance"],"title":"Problem","description":"Error structure for REST interface based on RFC 9457, \"Problem Details for HTTP APIs.\""},"Project":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the project.","example":"proj-abc123"},"name":{"type":"string","title":"Name","description":"Human-readable name of the project.","example":"Climate Simulation"},"description":{"type":"string","title":"Description","description":"Detailed description of the project.","example":"Research project studying atmospheric dynamics."},"user_ids":{"items":{"type":"string"},"type":"array","title":"User Ids","description":"List of user identifiers participating in the project.","example":["user-123","user-456"]},"last_modified":{"type":"string","format":"date-time","title":"Last Modified","description":"Timestamp of the last modification of the project.","example":"2026-02-21T14:30:00Z"},"self_uri":{"type":"string","title":"Self Uri","description":"URI to this project resource","readOnly":true}},"additionalProperties":true,"type":"object","required":["id","name","description","user_ids","last_modified","self_uri"],"title":"Project","description":"A project and its users at a facility"},"ProjectAllocation":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the project allocation.","example":"alloc-001"},"entries":{"items":{"$ref":"#/components/schemas/AllocationEntry"},"type":"array","title":"Entries","description":"Allocation entries describing usage and limits."},"project_uri":{"type":"string","title":"Project Uri","description":"URI of the associated project resource","readOnly":true},"capability_uri":{"type":"string","title":"Capability Uri","description":"URI of the associated capability resource","readOnly":true}},"additionalProperties":true,"type":"object","required":["id","entries","project_uri","capability_uri"],"title":"ProjectAllocation","description":"A project's allocation for a capability. (aka. repo)\nThis allocation is a piece of the total allocation for the capability. (eg. 5% of the total node hours of Perlmutter GPU nodes)\nA project would at least have a storage and job repos, maybe more than 1 of each."},"PutFileChmodRequest":{"properties":{"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"Source file or directory path","example":"/home/user/dir"},"mode":{"type":"string","title":"Mode","description":"Mode in octal permission format","example":"777"}},"type":"object","required":["mode"],"title":"PutFileChmodRequest","description":"Represents a request to change file permissions.","examples":[{"mode":"777","path":"/home/user/dir/file.out"}]},"PutFileChownRequest":{"properties":{"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"Source file or directory path","example":"/home/user/dir"},"owner":{"type":"string","title":"Owner","description":"User name of the new user owner of the file","default":"","example":"user"},"group":{"type":"string","title":"Group","description":"Group name of the new group owner of the file","default":"","example":"my-group"}},"type":"object","title":"PutFileChownRequest","description":"Represents a request to change file ownership.","examples":[{"group":"my-group","owner":"user","path":"/home/user/dir/file.out"}]},"Resolution":{"type":"string","enum":["unresolved","cancelled","completed","extended","pending"],"title":"Resolution","description":"Represents the resolution status of an incident."},"Resource":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier for the object. Typically a UUID or URN.","example":"urn:iri:object:1234"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The long name of the object.","example":"Perlmutter GPU"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Human-readable description of the object.","example":"High-performance GPU compute resource"},"last_modified":{"type":"string","format":"date-time","title":"Last Modified","description":"ISO 8601 timestamp when this object was last modified.","example":"2026-02-21T12:00:00Z"},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group","description":"Logical grouping of the resource","example":"frontend"},"current_status":{"anyOf":[{"$ref":"#/components/schemas/Status"},{"type":"null"}],"description":"The current status comes from the status of the last event for this resource","example":"up"},"resource_type":{"$ref":"#/components/schemas/ResourceType","description":"Type of the resource","example":"service"},"self_uri":{"type":"string","title":"Self Uri","description":"The canonical URL of this object","readOnly":true},"site_uri":{"type":"string","title":"Site Uri","description":"URI of the site where this resource is located","readOnly":true},"capability_uris":{"items":{"type":"string"},"type":"array","title":"Capability Uris","description":"The list of capabilities in this resource","readOnly":true}},"additionalProperties":true,"type":"object","required":["id","last_modified","resource_type","self_uri","site_uri","capability_uris"],"title":"Resource","description":"Represents a resource in the system."},"ResourceSpec":{"properties":{"node_count":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Node Count","description":"Number of compute nodes to allocate","example":2},"process_count":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Process Count","description":"Total number of processes to launch","example":64},"processes_per_node":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Processes Per Node","description":"Number of processes to launch per node","example":32},"cpu_cores_per_process":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Cpu Cores Per Process","description":"Number of CPU cores to allocate per process","example":2},"gpu_cores_per_process":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Gpu Cores Per Process","description":"Number of GPU cores to allocate per process","example":1},"exclusive_node_use":{"type":"boolean","title":"Exclusive Node Use","description":"Whether to request exclusive use of allocated nodes","default":true,"example":true},"memory":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Memory","description":"Amount of memory to allocate in bytes","example":17179869184}},"additionalProperties":true,"type":"object","title":"ResourceSpec","description":"Specification of computational resources required for a job."},"ResourceType":{"type":"string","enum":["website","service","compute","system","storage","network","unknown"],"title":"ResourceType","description":"Represents the type of a resource."},"Site":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier for the object. Typically a UUID or URN.","example":"urn:iri:object:1234"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The long name of the object.","example":"Perlmutter GPU"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Human-readable description of the object.","example":"High-performance GPU compute resource"},"last_modified":{"type":"string","format":"date-time","title":"Last Modified","description":"ISO 8601 timestamp when this object was last modified.","example":"2026-02-21T12:00:00Z"},"short_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Name","description":"Common or short name of the Site.","example":"NERSC"},"operating_organization":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Operating Organization","description":"Organization operating the Site.","example":"Lawrence Berkeley National Laboratory"},"country_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Name","description":"Country name of the Location.","example":"United States"},"locality_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locality Name","description":"City or locality name of the Location.","example":"Berkeley"},"state_or_province_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State Or Province Name","description":"State or province name of the Location.","example":"California"},"street_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street Address","description":"Street address of the Location.","example":"1 Cyclotron Rd"},"unlocode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unlocode","description":"United Nations trade and transport location code.","example":"USOAK"},"altitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Altitude","description":"Altitude of the Location.","example":52.0},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude","description":"Latitude of the Location.","example":37.8762},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude","description":"Longitude of the Location.","example":-122.2506},"self_uri":{"type":"string","title":"Self Uri","description":"The canonical URL of this object","readOnly":true},"resource_uris":{"items":{"type":"string"},"type":"array","title":"Resource Uris","description":"URIs of Resources hosted at this Site.","readOnly":true}},"additionalProperties":true,"type":"object","required":["id","last_modified","operating_organization","self_uri","resource_uris"],"title":"Site","description":"A physical site that hosts resources and is part of a facility."},"Status":{"type":"string","enum":["up","down","degraded","unknown"],"title":"Status","description":"Represents the status of a resource."},"Task":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the task","example":"task-123"},"status":{"$ref":"#/components/schemas/TaskStatus","description":"Current status of the task","default":"pending","example":"pending"},"result":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Result","description":"Result of the task execution, if available"},"command":{"anyOf":[{"$ref":"#/components/schemas/TaskCommand"},{"type":"null"}],"description":"Command associated with this task"}},"type":"object","required":["id"],"title":"Task","description":"Represents a task in the system."},"TaskCommand":{"properties":{"router":{"type":"string","title":"Router","description":"Router name the task comes from","example":"filesystem"},"command":{"type":"string","title":"Command","description":"Command to execute","example":"chmod"},"args":{"additionalProperties":true,"type":"object","title":"Args","description":"Command arguments as key-value pairs","example":{"mode":"755","path":"/home/user/file"}}},"type":"object","required":["router","command","args"],"title":"TaskCommand","description":"Represents a command to be executed as part of a task."},"TaskStatus":{"type":"string","enum":["pending","active","completed","failed","canceled"],"title":"TaskStatus","description":"Represents the status of a task."},"TaskSubmitResponse":{"properties":{"task_id":{"type":"string","title":"Task Id","description":"Identifier of the submitted task","example":"task-123"},"task_uri":{"type":"string","title":"Task Uri","description":"The list of past events in this incident","readOnly":true}},"type":"object","required":["task_id","task_uri"],"title":"TaskSubmitResponse","description":"Response model for submitting a task"},"UserAllocation":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the user allocation.","example":"user-alloc-42"},"user_id":{"type":"string","title":"User Id","description":"Identifier of the user receiving this allocation.","example":"user-123"},"entries":{"items":{"$ref":"#/components/schemas/AllocationEntry"},"type":"array","title":"Entries","description":"Allocation entries describing usage and limits."},"project_allocation_uri":{"type":"string","title":"Project Allocation Uri","description":"URI of the associated project allocation","readOnly":true}},"additionalProperties":true,"type":"object","required":["id","user_id","entries","project_allocation_uri"],"title":"UserAllocation","description":"A user's allcation in a project.\nThis allocation is a piece of the project's allocation."},"VolumeMount":{"properties":{"source":{"type":"string","minLength":1,"title":"Source","description":"The source path on the host system to mount","example":"/data/project"},"target":{"type":"string","minLength":1,"title":"Target","description":"The target path inside the container where the volume will be mounted","example":"/mnt/data"},"read_only":{"type":"boolean","title":"Read Only","description":"Whether the mount should be read-only","default":true,"example":true}},"additionalProperties":true,"type":"object","required":["source","target"],"title":"VolumeMount","description":"Represents a volume mount for a container."}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}}}