{"openapi":"3.1.0","info":{"title":"FarEarth Developer API","description":"Details on how to interact with FarEarth. To interact with the API, an API key needs to be attached as a 'X-API-Key' HTTP header parameter.","version":"3.19.11"},"externalDocs":{"description":"FarEarth Developer API documentation","url":"https://gateway.farearth.space/ui/developer/api"},"servers":[{"url":"https://gateway.farearth.space"}],"security":[{"X-API-Key":["read","write"]}],"tags":[{"name":"Workflow CRUD endpoints","description":"Endpoints to manage workflows"},{"name":"Event output CRUD endpoints","description":"Endpoints to manage event outputs"},{"name":"Data host CRUD endpoints","description":"Endpoints to manage data hosts"},{"name":"Sensor list endpoint","description":"Endpoint to list sensors"},{"name":"Order endpoints","description":"Endpoints to manage subscription orders"},{"name":"App list endpoint","description":"Endpoint to list subscription apps"},{"name":"Archive CRUD endpoints","description":"Endpoints to manage archives"},{"name":"Hub item list endpoint","description":"Endpoint to list hub items"},{"name":"Test endpoint","description":"Test endpoints to validate access"},{"name":"Collection CRUD endpoints","description":"Endpoints to manage collections"},{"name":"Resources properties endpoints","description":"Endpoints to manage resource properties"},{"name":"Secrets CRUD endpoints","description":"Endpoints to manage secrets"},{"name":"Data host list endpoint","description":"Endpoint to list data hosts"},{"name":"Workflow list endpoint","description":"Endpoint to list workflows"},{"name":"Secrets list endpoint","description":"Endpoint to list secrets"},{"name":"App version endpoint","description":"Endpoint returns app versions"},{"name":"Hub item CRUD endpoints","description":"Endpoints to manage hub items"},{"name":"Executor list endpoint","description":"Endpoint to list executors"},{"name":"Collection list endpoint","description":"Endpoint to list collections"},{"name":"Event output list endpoint","description":"Endpoint to list event outputs"},{"name":"Runtimes list endpoint","description":"Endpoint to list processing runtimes"},{"name":"Pickup CRUD endpoints","description":"Endpoints to manage pickups"},{"name":"Pickup data ready endpoint","description":"Endpoint to trigger processing of data available within a pickup"},{"name":"Runtime CRUD endpoints","description":"Endpoints to manage processing runtime factories"},{"name":"Executor CRUD endpoints","description":"Endpoints to manage executors"},{"name":"STAC endpoint","description":"STAC operations"},{"name":"Subscription user list endpoint","description":"Endpoint to list subscription users"},{"name":"Subscription user CRUD endpoints","description":"Endpoints to manage subscription users"},{"name":"Archive list endpoint","description":"Endpoint to list archives"},{"name":"Sensor CRUD endpoints","description":"Endpoints to manage sensors"},{"name":"Archive data endpoint","description":"Endpoint to perform tasks against Archives, such as starting orders"},{"name":"Pickup list endpoint","description":"Endpoint to list pickups"}],"paths":{"/api/ext/v1/user/{email}":{"get":{"tags":["Subscription user CRUD endpoints"],"summary":"Get user","description":"Returns a user with the given email address that is assigned to the current subscription","operationId":"getUser","parameters":[{"name":"email","in":"path","required":true,"schema":{"type":"string"},"example":"john.doe@example.com"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/User"}}}},"404":{"description":"User not found"},"401":{"description":"Unauthorized"}}},"put":{"tags":["Subscription user CRUD endpoints"],"summary":"Invite user","description":"Invite a user to the current subscription","operationId":"inviteUser","parameters":[{"name":"email","in":"path","required":true,"schema":{"type":"string"},"example":"john.doe@example.com"}],"responses":{"200":{"description":"OK"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"delete":{"tags":["Subscription user CRUD endpoints"],"summary":"Remove user","description":"Remove the user with the given email address from the current subscription","operationId":"removeUser","parameters":[{"name":"email","in":"path","required":true,"schema":{"type":"string"},"example":"john.doe@example.com"}],"responses":{"200":{"description":"OK"},"403":{"description":"Cannot remove own user"},"404":{"description":"User not found"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/resources/{app}/{type}/{resource}/shareable":{"put":{"tags":["Resources properties endpoints"],"summary":"Make resource shareable","description":"Mark the resource as shareable with other subscription","operationId":"setResourceShareable","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"type","in":"path","required":true,"schema":{"type":"string","enum":["Director","Datapoint","Catalogue","Event Output","Processor","Pickup","Archive","Data Host","Collection","Executor","Runtime","Hub Item","Workflow","Sensor"],"example":"Workflow"},"example":"Workflow"},{"name":"resource","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.diagnostics"},{"name":"shareable","in":"query","description":"Whether the resource should be marked as shareable with other subscriptions","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK"},"404":{"description":"Subscription not found"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/resources/{app}/{type}/{resource}/exclusive":{"put":{"tags":["Resources properties endpoints"],"summary":"Make resource exclusive","description":"Mark the resource as exclusive or not","operationId":"setResourceExclusive","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"type","in":"path","required":true,"schema":{"type":"string","enum":["Director","Datapoint","Catalogue","Processor","Pickup","Archive","Data Host","Collection","Executor","Runtime","Hub Item","Workflow","Sensor"],"example":"Workflow"},"example":"Workflow"},{"name":"resource","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.diagnostics"},{"name":"exclusive","in":"query","description":"Whether the resource should be marked as exclusive","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK"},"404":{"description":"Subscription not found"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/resources/{app}/{type}/{resource}/enabled":{"put":{"tags":["Resources properties endpoints"],"summary":"Enable resource","description":"Mark the resource as enabled or disabled","operationId":"setResourceEnabled","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"type","in":"path","required":true,"schema":{"type":"string","enum":["Director","Datapoint","Catalogue","Processor","Pickup","Archive","Data Host","Collection","Executor","Runtime","Hub Item","Workflow","Sensor"],"example":"Workflow"},"example":"Workflow"},{"name":"resource","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.diagnostics"},{"name":"enabled","in":"query","description":"Whether the resource should be enabled","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK"},"404":{"description":"Subscription not found"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/workflow/{fileName}":{"get":{"tags":["Workflow CRUD endpoints"],"summary":"Get workflow","description":"Get a workflow","operationId":"getWorkflow","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-workflow.workflow.json"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Workflow"}}}},"400":{"description":"Could not parse workflow file"},"404":{"description":"Workflow config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"put":{"tags":["Workflow CRUD endpoints"],"summary":"Create workflow","description":"Create a new workflow","operationId":"createWorkflow","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-workflow.workflow.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workflow"}}},"required":true},"responses":{"200":{"description":"OK"},"403":{"description":"Not authorized, resource file already exists or invalid subscription"},"401":{"description":"Unauthorized"}}},"delete":{"tags":["Workflow CRUD endpoints"],"summary":"Delete workflow","description":"Delete an existing workflow","operationId":"deleteWorkflow","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-workflow.workflow.json"}],"responses":{"200":{"description":"OK"},"404":{"description":"Workflow config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"patch":{"tags":["Workflow CRUD endpoints"],"summary":"Update workflow","description":"Update an existing workflow","operationId":"updateWorkflow","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-workflow.workflow.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workflow"}}},"required":true},"responses":{"200":{"description":"OK"},"404":{"description":"Workflow config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/sensor/{fileName}":{"get":{"tags":["Sensor CRUD endpoints"],"summary":"Get sensor","description":"Get a sensor","operationId":"getSensor","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-sensor.sensor.json"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Sensor"}}}},"400":{"description":"Could not parse sensor config file"},"404":{"description":"Sensor config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"put":{"tags":["Sensor CRUD endpoints"],"summary":"Create sensor","description":"Create a new sensor","operationId":"createSensor","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-sensor.sensor.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sensor"}}},"required":true},"responses":{"200":{"description":"OK"},"403":{"description":"Not authorized, resource file already exists or invalid subscription"},"401":{"description":"Unauthorized"}}},"delete":{"tags":["Sensor CRUD endpoints"],"summary":"Delete sensor","description":"Delete an existing sensor","operationId":"deleteSensor","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-sensor.sensor.json"}],"responses":{"200":{"description":"OK"},"404":{"description":"Sensor config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"patch":{"tags":["Sensor CRUD endpoints"],"summary":"Update sensor","description":"Update an existing sensor","operationId":"updateSensor","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-sensor.sensor.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sensor"}}},"required":true},"responses":{"200":{"description":"OK"},"404":{"description":"Sensor config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/secrets/{fileName}":{"get":{"tags":["Secrets CRUD endpoints"],"summary":"Get secrets config","description":"Get a secrets config","operationId":"getSecrets","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-secret.secret.json"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SecretsConfig"}}}},"400":{"description":"Could not parse secrets config file"},"404":{"description":"Secrets config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"put":{"tags":["Secrets CRUD endpoints"],"summary":"Create secrets","description":"Create a new secrets provider","operationId":"createSecrets","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-secret.secret.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretsConfig"}}},"required":true},"responses":{"200":{"description":"OK"},"403":{"description":"Not authorized, resource file already exists or invalid subscription"},"401":{"description":"Unauthorized"}}},"delete":{"tags":["Secrets CRUD endpoints"],"summary":"Delete secrets config","description":"Delete an existing secrets config","operationId":"deleteSecretsConfig","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-secret.secret.json"}],"responses":{"200":{"description":"OK"},"404":{"description":"Secrets config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"patch":{"tags":["Secrets CRUD endpoints"],"summary":"Update secrets","description":"Update an existing secrets config","operationId":"updateSecretsConfig","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-secret.secret.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretsConfig"}}},"required":true},"responses":{"200":{"description":"OK"},"404":{"description":"Secrets config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/runtime/{fileName}":{"get":{"tags":["Runtime CRUD endpoints"],"summary":"Get runtime","description":"Get a processing runtime factory configuration","operationId":"getRuntime","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-runtime.runtime.json"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Runtime"}}}},"400":{"description":"Could not parse processing runtime factory config file"},"404":{"description":"Runtime config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"put":{"tags":["Runtime CRUD endpoints"],"summary":"Create runtime","description":"Create a new processing runtime factory","operationId":"createRuntime","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-runtime.runtime.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Runtime"}}},"required":true},"responses":{"200":{"description":"OK"},"403":{"description":"Not authorized, resource file already exists or invalid subscription"},"401":{"description":"Unauthorized"}}},"delete":{"tags":["Runtime CRUD endpoints"],"summary":"Delete runtime","description":"Delete an existing runtime configuration","operationId":"deleteRuntime","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-runtime.runtime.json"}],"responses":{"200":{"description":"OK"},"404":{"description":"Processing runtime config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"patch":{"tags":["Runtime CRUD endpoints"],"summary":"Update runtime","description":"Update an existing processing runtime factory configuration","operationId":"updateRuntime","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-runtime.runtime.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Runtime"}}},"required":true},"responses":{"200":{"description":"OK"},"404":{"description":"Processing runtime factory config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/pickup/{fileName}":{"get":{"tags":["Pickup CRUD endpoints"],"summary":"Get pickup","description":"Get a pickup","operationId":"getPickup","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-pickup.pickup.json"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Pickup"}}}},"400":{"description":"Could not parse pickup config file"},"404":{"description":"Pickup config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"put":{"tags":["Pickup CRUD endpoints"],"summary":"Create pickup","description":"Create a new pickup","operationId":"createPickup","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-pickup.pickup.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pickup"}}},"required":true},"responses":{"200":{"description":"OK"},"403":{"description":"Not authorized, resource file already exists or invalid subscription"},"401":{"description":"Unauthorized"}}},"delete":{"tags":["Pickup CRUD endpoints"],"summary":"Delete pickup","description":"Delete an existing pickup","operationId":"deletePickup","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-pickup.pickup.json"}],"responses":{"200":{"description":"OK"},"404":{"description":"Pickup config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"patch":{"tags":["Pickup CRUD endpoints"],"summary":"Update pickup","description":"Update an existing pickup","operationId":"updatePickup","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-pickup.pickup.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pickup"}}},"required":true},"responses":{"200":{"description":"OK"},"404":{"description":"Pickup config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/hubItem/{fileName}":{"get":{"tags":["Hub item CRUD endpoints"],"summary":"Get hub item","description":"Get a hub item","operationId":"getHubItem","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-hub-item.hub.json"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HubItem"}}}},"400":{"description":"Could not parse hub item file"},"404":{"description":"Hub item config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"put":{"tags":["Hub item CRUD endpoints"],"summary":"Create hub item","description":"Create a new hub item","operationId":"createHubItem","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-hub-item.hub.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HubItem"}}},"required":true},"responses":{"200":{"description":"OK"},"403":{"description":"Not authorized, resource file already exists or invalid subscription"},"401":{"description":"Unauthorized"}}},"delete":{"tags":["Hub item CRUD endpoints"],"summary":"Delete hub item","description":"Delete an existing hub item","operationId":"deleteHubItem","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-hub-item.hub.json"}],"responses":{"200":{"description":"OK"},"404":{"description":"Hub item config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"patch":{"tags":["Hub item CRUD endpoints"],"summary":"Update hub item","description":"Update an existing hub item","operationId":"updateHubItem","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-hub-item.hub.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HubItem"}}},"required":true},"responses":{"200":{"description":"OK"},"404":{"description":"Hub item config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/eventOutputs/{fileName}":{"get":{"tags":["Event output CRUD endpoints"],"summary":"Get event output config","description":"Get a event output config","operationId":"getEventOutput","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-event-output.event-output.json"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EventOutputConfig"}}}},"400":{"description":"Could not parse event output config file"},"404":{"description":"Event output config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"put":{"tags":["Event output CRUD endpoints"],"summary":"Create event output","description":"Create a new event output","operationId":"createEventOutput","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-event-output.event-output.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventOutputConfig"}}},"required":true},"responses":{"200":{"description":"OK"},"403":{"description":"Not authorized, resource file already exists or invalid subscription"},"401":{"description":"Unauthorized"}}},"delete":{"tags":["Event output CRUD endpoints"],"summary":"Delete event output config","description":"Delete an existing event output config","operationId":"deleteEventOutputConfig","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-event-output.event-output.json"}],"responses":{"200":{"description":"OK"},"404":{"description":"Event output config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"patch":{"tags":["Event output CRUD endpoints"],"summary":"Update event output","description":"Update an existing event output config","operationId":"updateEventOutputConfig","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-event-output.event-output.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventOutputConfig"}}},"required":true},"responses":{"200":{"description":"OK"},"404":{"description":"Event output config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/dataHost/{fileName}":{"get":{"tags":["Data host CRUD endpoints"],"summary":"Get data host","description":"Get a data host","operationId":"getDataHost","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-data-host.host.json"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DataHost"}}}},"400":{"description":"Could not parse Datahost config file"},"404":{"description":"Data host config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"put":{"tags":["Data host CRUD endpoints"],"summary":"Create data host","description":"Create a new data host","operationId":"createDataHost","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-data-host.host.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataHost"}}},"required":true},"responses":{"200":{"description":"OK"},"403":{"description":"Not authorized, resource file already exists or invalid subscription"},"401":{"description":"Unauthorized"}}},"delete":{"tags":["Data host CRUD endpoints"],"summary":"Delete data host","description":"Delete an existing data host","operationId":"deleteDataHost","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-data-host.host.json"}],"responses":{"200":{"description":"OK"},"404":{"description":"Data host config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"patch":{"tags":["Data host CRUD endpoints"],"summary":"Update data host","description":"Update an existing data host","operationId":"updateDataHost","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-data-host.host.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataHost"}}},"required":true},"responses":{"200":{"description":"OK"},"404":{"description":"Data host config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/collection/{fileName}":{"get":{"tags":["Collection CRUD endpoints"],"summary":"Get collection","description":"Get a collection","operationId":"getCollection","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-collection.collection.json"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Collection"}}}},"400":{"description":"Could not parse Collection config file"},"404":{"description":"Collection config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"put":{"tags":["Collection CRUD endpoints"],"summary":"Create collection","description":"Create a new collection","operationId":"createCollection","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-collection.collection.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}},"required":true},"responses":{"200":{"description":"OK"},"403":{"description":"Not authorized, resource file already exists or invalid subscription"},"401":{"description":"Unauthorized"}}},"delete":{"tags":["Collection CRUD endpoints"],"summary":"Delete collection","description":"Delete an existing collection","operationId":"deleteCollection","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-collection.collection.json"}],"responses":{"200":{"description":"OK"},"404":{"description":"Collection config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"patch":{"tags":["Collection CRUD endpoints"],"summary":"Update collection","description":"Update an existing collection","operationId":"updateCollection","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-collection.collection.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}},"required":true},"responses":{"200":{"description":"OK"},"404":{"description":"Collection config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/archive/{fileName}":{"get":{"tags":["Archive CRUD endpoints"],"summary":"Get archive","description":"Get a archive","operationId":"getArchive","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-archive.archive.json"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Archive"}}}},"400":{"description":"Could not parse Archive config file"},"404":{"description":"Archive config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}},"put":{"tags":["Archive CRUD endpoints"],"summary":"Create archive","description":"Create a new archive","operationId":"createArchive","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-archive.archive.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Archive"}}},"required":true},"responses":{"200":{"description":"OK"},"403":{"description":"Not authorized, resource file already exists or invalid subscription"},"401":{"description":"Unauthorized"}}},"patch":{"tags":["Archive CRUD endpoints"],"summary":"Update archive","description":"Update an existing archive","operationId":"updateArchive","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-archive.archive.json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Archive"}}},"required":true},"responses":{"200":{"description":"OK"},"404":{"description":"Archive config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/stac/catalogs/{farearthCatalogueId}/{catalogId}/search":{"get":{"tags":["STAC endpoint"],"summary":"Search catalog GET","description":"Returns STAC items for a given search query.","operationId":"searchByGet","parameters":[{"name":"farearthCatalogueId","in":"path","description":"The FarEarth catalogue App ID","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"catalogId","in":"path","description":"The STAC catalog ID (only differs when the STAC catalog is proxied behind the FarEarth App)","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"bbox","in":"query","description":"A search bounding box","required":false,"schema":{"type":"array","items":{"type":"number","format":"double"}},"example":[-180.0,-90.0,180.0,90.0]},{"name":"datetime","in":"query","description":"Search the following interval","required":false,"schema":{"type":"string"},"example":"2023-04-22T09:31:16.073Z/2024-04-22T21:59:59.999Z"},{"name":"limit","in":"query","description":"Use the following page size (max 15)","required":false,"schema":{"type":"integer","format":"int32"},"example":5},{"name":"page","in":"query","description":"Start from the following page index (starting at 1)","required":false,"schema":{"type":"integer","format":"int32"},"example":2},{"name":"ids","in":"query","description":"Include the following feature IDs","required":false,"schema":{"type":"array","items":{"type":"string"}},"example":"S2A_34HBH_20240227_0_L1C"},{"name":"collections","in":"query","description":"Include the following collections","required":false,"schema":{"type":"array","items":{"type":"string"}},"example":"farearth.sentinel-l1c"},{"name":"fields","in":"query","description":"Include/exclude fields","required":false,"schema":{"type":"string"},"example":"properties.eo:cloud_cover,-properties.correlationId"},{"name":"sortby","in":"query","description":"Sort by fields","required":false,"schema":{"type":"string"},"example":"properties.eo:cloud_cover,-properties.correlationId"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StacItemCollection"}}}},"503":{"description":"STAC catalog not found or unavailable"},"401":{"description":"Unauthorized"}}},"post":{"tags":["STAC endpoint"],"summary":"Search catalog POST","description":"Returns STAC items for a given search query.","operationId":"searchByPost","parameters":[{"name":"farearthCatalogueId","in":"path","description":"The FarEarth catalogue App ID","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"catalogId","in":"path","description":"The STAC catalog ID (only differs when the STAC catalog is proxied behind the FarEarth App)","required":true,"schema":{"type":"string"},"example":"farearth.gateway"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchDetails"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StacItemCollection"}}}},"503":{"description":"STAC catalog not found or unavailable"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/stac/catalogs/{farearthCatalogueId}/{catalogId}/search/next":{"get":{"tags":["STAC endpoint"],"summary":"Search catalog GET (next page)","description":"Returns STAC items for a given search query.","operationId":"searchByGetNext","parameters":[{"name":"farearthCatalogueId","in":"path","description":"The FarEarth catalogue App ID","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"catalogId","in":"path","description":"The STAC catalog ID (only differs when the STAC catalog is proxied behind the FarEarth App)","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"data","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StacItemCollection"}}}},"503":{"description":"STAC catalog not found or unavailable"},"401":{"description":"Unauthorized"}}},"post":{"tags":["STAC endpoint"],"summary":"Search catalog POST (next page)","description":"Returns STAC items for a given search query.","operationId":"searchByPostNext","parameters":[{"name":"farearthCatalogueId","in":"path","description":"The FarEarth catalogue App ID","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"catalogId","in":"path","description":"The STAC catalog ID (only differs when the STAC catalog is proxied behind the FarEarth App)","required":true,"schema":{"type":"string"},"example":"farearth.gateway"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchNextBody"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StacItemCollection"}}}},"503":{"description":"STAC catalog not found or unavailable"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/pickups/{pickupId}/markInputReady":{"post":{"tags":["Pickup data ready endpoint"],"summary":"Mark data ready","description":"Mark pickup data as ready for processing. This method requires all metadata to be included in the body (in contrast to 'markFileReady' and 'markFolderReady', which fetches the metadata from the storage volume)","operationId":"markInputReady","parameters":[{"name":"pickupId","in":"path","description":"The FarEarth pickup ID","required":true,"schema":{"type":"string"},"example":"trueorbit.my-pickup"},{"name":"timeZoneOffset","in":"query","description":"An optional timezone offset (notifications will be sent according to this zone, e.g. 0 for UTC)","required":false,"schema":{"type":"integer","format":"int32","default":0},"example":0}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadyData"}}},"required":true},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Invalid input provided"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/pickups/{pickupId}/markFolderReady":{"post":{"tags":["Pickup data ready endpoint"],"summary":"Mark folder ready","description":"Mark pickup folder as ready for processing. Relevant meta-data will be extracted from the trigger strategy specified (e.g., 'PRODUCT_FILE', 'READY_FILE', etc).","operationId":"markFolderReady","parameters":[{"name":"pickupId","in":"path","description":"The FarEarth pickup ID","required":true,"schema":{"type":"string"},"example":"trueorbit.my-pickup"},{"name":"timeZoneOffset","in":"query","description":"An optional timezone offset (notifications will be sent according to this zone, e.g. 0 for UTC)","required":false,"schema":{"type":"integer","format":"int32","default":0},"example":0},{"name":"path","in":"query","description":"The path of the folder that will be used as trigger","required":true,"schema":{"type":"string"},"example":"relative/path/within/pickup/folder"},{"name":"triggerStrategyId","in":"query","description":"The trigger type used to extract metadata (supported triggers: PRODUCT_FILE, READY_FILE, ACCEPT_ALL, FOLDER_SUFFIX, FILE_MANIFEST, MD5_FILE and NO_CHANGE)","required":false,"schema":{"type":"string"},"example":"PRODUCT_FILE"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Any additional order parameters to be injected in the resulting order can also be optionally included in the post."}}},"required":true},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/pickups/{pickupId}/markFileReady":{"post":{"tags":["Pickup data ready endpoint"],"summary":"Mark file ready","description":"Mark pickup file as ready for processing (this should be used if no extra meta-data is available, e.g., for RAW files))","operationId":"markFileReady","parameters":[{"name":"pickupId","in":"path","description":"The FarEarth pickup ID","required":true,"schema":{"type":"string"},"example":"trueorbit.my-pickup"},{"name":"timeZoneOffset","in":"query","description":"An optional timezone offset (notifications will be sent according to this zone, e.g. 0 for UTC)","required":false,"schema":{"type":"integer","format":"int32","default":0},"example":0},{"name":"path","in":"query","description":"The path of the single file that will be used as trigger","required":true,"schema":{"type":"string"},"example":"relative/path/within/pickup/folder/raw.zip"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Any additional order parameters to be injected in the resulting order can also be optionally included in the post."}}},"required":true},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/orders/workflow/{workflowId}/start":{"post":{"tags":["Order endpoints"],"summary":"Start order from workflowId","description":"Start a new order given the provided workflowId","operationId":"startWorkflow","parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-workflow"},{"name":"appId","in":"query","required":false,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"timeZoneOffset","in":"query","description":"An optional timezone offset (notifications will be sent according to this zone, e.g. 0 for UTC)","required":false,"schema":{"type":"integer","format":"int32","default":0},"example":0}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Any additional order parameters to be injected in the resulting order can also be optionally included in the post."}}},"required":true},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Failed to start order"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/orders/search":{"post":{"tags":["Order endpoints"],"summary":"Search orders","description":"Search orders using filters. Sorted by newest first.","operationId":"searchOrders","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderFilter"}}},"required":true},"responses":{"200":{"description":"A list of matching orders","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdersPage"}}}},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/orders/diagnostics/start":{"post":{"tags":["Order endpoints"],"summary":"Start diagnostics order","description":"Start a diagnostics order","operationId":"startDiagnosticsOrder","parameters":[{"name":"timeZoneOffset","in":"query","description":"An optional timezone offset (notifications will be sent according to this zone, e.g. 0 for UTC)","required":false,"schema":{"type":"integer","format":"int32","default":0},"example":0}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Failed to start order"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/archives/{farearthCatalogueId}/markProductReady":{"post":{"tags":["Archive data endpoint"],"summary":"Mark data ready","description":"Mark archive data as ready for processing","operationId":"markProductReady","parameters":[{"name":"farearthCatalogueId","in":"path","description":"The FarEarth catalogue App ID","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"id","in":"query","description":"Include the following feature IDs","required":true,"schema":{"type":"string"},"example":"S2A_34HBH_20240227_0_L1C"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Any additional order parameters to be injected in the resulting order can also be optionally included in the post."}}},"required":true},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Invalid subscription"},"404":{"description":"Product ID not found"},"409":{"description":"Conflict in more than one product found"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/archives/{farearthCatalogueId}/markBulkInputFileReady":{"post":{"tags":["Archive data endpoint"],"summary":"Mark data ready","description":"Mark Bulk Input File ready for processing","operationId":"markBulkInputFileReady","parameters":[{"name":"farearthCatalogueId","in":"path","description":"The FarEarth catalogue App ID","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"id","in":"query","description":"Include the following feature IDs","required":true,"schema":{"type":"string"},"example":"S2A_34HBH_20240227_0_L1C"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Any additional order parameters to be injected in the resulting order can also be optionally included in the post."}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Invalid subscription"},"404":{"description":"Product ID not found"},"409":{"description":"Conflict in more than one product found"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/archives/{archiveId}/synchronize":{"post":{"tags":["Archive data endpoint"],"summary":"Synchronize archive","description":"Synchronize catalogue with archive storage","operationId":"synchronizeArchive","parameters":[{"name":"archiveId","in":"path","description":"The FarEarth Archive ID","required":true,"schema":{"type":"string"},"example":"farearth.azure-archive"},{"name":"subscriptionId","in":"query","description":"Against which subscriptions synchronization should be performed (defaults to current subscription)","required":false,"schema":{"type":"array","items":{"type":"string"}},"example":"farearth"},{"name":"deleteCatalogueProductsMissingFromArchive","in":"query","description":"Whether products in the Catalogue should be removed if they're no longer present in the Archive (defaults to true)","required":false,"schema":{"type":"boolean","default":true}},{"name":"createCatalogueProductsFoundInArchive","in":"query","description":"Whether new products should be created in the Catalogue if they're found in the Archive (defaults to false)","required":false,"schema":{"type":"boolean","default":false}},{"name":"timeZoneOffset","in":"query","description":"An optional timezone offset (notifications will be sent according to this zone, e.g. 0 for UTC)","required":false,"schema":{"type":"integer","format":"int32","default":0},"example":0},{"name":"ageLimitMinutes","in":"query","description":"An optional age limit in minutes to allow ignoring orders that might be busy","required":false,"schema":{"type":"integer","format":"int32","default":240},"example":240}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Request error"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/archives/migrate":{"post":{"tags":["Archive data endpoint"],"summary":"Migrate archive","description":"Migrate binary files from an archive to another archive","operationId":"migrateArchive","parameters":[{"name":"timeZoneOffset","in":"query","description":"An optional timezone offset (notifications will be sent according to this zone, e.g. 0 for UTC)","required":false,"schema":{"type":"integer","format":"int32","default":0},"example":0}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The Source and Destination Archive ID and optional STAC SearchDetails should be included in the body."}}},"required":true},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Request error"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/archive/{fileName}/delete":{"post":{"tags":["Archive CRUD endpoints"],"summary":"Delete archive","description":"Delete an existing archive","operationId":"deleteArchive","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"fileName","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-archive.archive.json"}],"requestBody":{"description":"A JSON body with a parameter to indicate if the binary data should also be deleted from the data store.","content":{"application/json":{"schema":{"type":"object"},"example":{"deleteFromDataStore":true}}},"required":true},"responses":{"200":{"description":"OK"},"404":{"description":"Archive config not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/version":{"get":{"tags":["App version endpoint"],"summary":"Get app version","description":"Returns the current app version","operationId":"getAppInfo","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AppVersion"}}}},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/users":{"get":{"tags":["Subscription user list endpoint"],"summary":"Get subscription users","description":"Get a page of users for the current subscription.","operationId":"getUsers","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of users","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/test/whoAmI":{"get":{"tags":["Test endpoint"],"summary":"WhoAmI endpoint","description":"Returns user details for the authenticated user.","operationId":"whoAmI","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}}}}},"/api/ext/v1/test/hello":{"get":{"tags":["Test endpoint"],"summary":"Say hello","description":"Returns a message with the current user's ID","operationId":"sayHello","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/api/ext/v1/stac":{"get":{"tags":["STAC endpoint"],"summary":"Landing page","description":"Return STAC landing page.","operationId":"getLandingPage","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StacLandingPage"}}}},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/stac/catalogs/{farearthCatalogueId}/{catalogId}":{"get":{"tags":["STAC endpoint"],"summary":"Catalog details","description":"Return available catalogs.","operationId":"getCatalog","parameters":[{"name":"farearthCatalogueId","in":"path","description":"The FarEarth catalogue App ID","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"catalogId","in":"path","description":"The STAC catalog ID (only differs when the STAC catalog is proxied behind the FarEarth App)","required":true,"schema":{"type":"string"},"example":"farearth.gateway"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StacCatalog"}}}},"503":{"description":"STAC catalog not found or unavailable"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/stac/catalogs/{farearthCatalogueId}/{catalogId}/conformance":{"get":{"tags":["STAC endpoint"],"summary":"Catalog conformance endpoint","description":"Return STAC catalog conformance endpoint.","operationId":"getCatalogConformance","parameters":[{"name":"farearthCatalogueId","in":"path","description":"The FarEarth catalogue App ID","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"catalogId","in":"path","description":"The STAC catalog ID (only differs when the STAC catalog is proxied behind the FarEarth App)","required":true,"schema":{"type":"string"},"example":"farearth.gateway"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StacConformance"}}}},"503":{"description":"STAC catalog not found or unavailable"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/stac/catalogs/{farearthCatalogueId}/{catalogId}/collections":{"get":{"tags":["STAC endpoint"],"summary":"Collections","description":"Return available collections.","operationId":"getCollectionsForCatalog","parameters":[{"name":"farearthCatalogueId","in":"path","description":"The FarEarth catalogue App ID","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"catalogId","in":"path","description":"The STAC catalog ID (only differs when the STAC catalog is proxied behind the FarEarth App)","required":true,"schema":{"type":"string"},"example":"farearth.gateway"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StacCollections"}}}},"503":{"description":"STAC catalog not found or unavailable"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/stac/catalogs/{farearthCatalogueId}/{catalogId}/collections/{collectionId}":{"get":{"tags":["STAC endpoint"],"summary":"Collection details","description":"Returns details relating to a specific collection","operationId":"getCollectionForCatalog","parameters":[{"name":"farearthCatalogueId","in":"path","description":"The FarEarth catalogue App ID","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"catalogId","in":"path","description":"The STAC catalog ID (only differs when the STAC catalog is proxied behind the FarEarth App)","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"collectionId","in":"path","description":"The STAC collection ID","required":true,"schema":{"type":"string"},"example":"farearth.sentinel-l1c"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StacCollection"}}}},"404":{"description":"STAC collection not found"},"503":{"description":"STAC catalog not found or unavailable"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/stac/catalogs/{farearthCatalogueId}/{catalogId}/collections/{collectionId}/items":{"get":{"tags":["STAC endpoint"],"summary":"Collection items","description":"Return the items associated with a specific collection.","operationId":"getCollectionItemsForCatalog","parameters":[{"name":"farearthCatalogueId","in":"path","description":"The FarEarth catalogue App ID","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"catalogId","in":"path","description":"The STAC catalog ID (only differs when the STAC catalog is proxied behind the FarEarth App)","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"collectionId","in":"path","description":"The STAC collection ID","required":true,"schema":{"type":"string"},"example":"farearth.sentinel-l1c"},{"name":"bbox","in":"query","description":"A search bounding box","required":false,"schema":{"type":"array","items":{"type":"number","format":"double"}},"example":[-180.0,-90.0,180.0,90.0]},{"name":"datetime","in":"query","description":"Search the following interval","required":false,"schema":{"type":"string"},"example":"2023-04-22T09:31:16.073Z/2024-04-22T21:59:59.999Z"},{"name":"limit","in":"query","description":"Use the following page size (max 15)","required":false,"schema":{"type":"integer","format":"int32"},"example":5},{"name":"page","in":"query","description":"Start from the following page index (starting at 1)","required":false,"schema":{"type":"integer","format":"int32"},"example":2},{"name":"ids","in":"query","description":"Include the following feature IDs","required":false,"schema":{"type":"array","items":{"type":"string"}},"example":"S2A_34HBH_20240227_0_L1C"},{"name":"collections","in":"query","description":"Include the following collections","required":false,"schema":{"type":"array","items":{"type":"string"}},"example":"farearth.sentinel-l1c"},{"name":"fields","in":"query","description":"Include/exclude fields","required":false,"schema":{"type":"string"},"example":"properties.eo:cloud_cover,-properties.correlationId"},{"name":"sortby","in":"query","description":"Sort by fields","required":false,"schema":{"type":"string"},"example":"properties.eo:cloud_cover,-properties.correlationId"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StacItemCollection"}}}},"503":{"description":"STAC catalog not found or unavailable"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/stac/catalogs/{farearthCatalogueId}/{catalogId}/collections/{collectionId}/items/{featureId}":{"get":{"tags":["STAC endpoint"],"summary":"Get STAC item","description":"Return the details of a specific STAC item.","operationId":"getItemByFeatureId","parameters":[{"name":"farearthCatalogueId","in":"path","description":"The FarEarth catalogue App ID","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"catalogId","in":"path","description":"The STAC catalog ID (only differs when the STAC catalog is proxied behind the FarEarth App)","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"collectionId","in":"path","description":"The STAC collection ID","required":true,"schema":{"type":"string"},"example":"farearth.sentinel-l1c"},{"name":"featureId","in":"path","description":"The STAC feature ID","required":true,"schema":{"type":"string"},"example":"S2A_34HBH_20240227_0_L1C"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StacItem"}}}},"404":{"description":"STAC item not found"},"503":{"description":"STAC catalog not found or unavailable"},"401":{"description":"Unauthorized"}}},"delete":{"tags":["STAC endpoint"],"summary":"Delete STAC item","description":"Deletes a specific STAC item.","operationId":"deleteItemByFeatureId","parameters":[{"name":"farearthCatalogueId","in":"path","description":"The FarEarth catalogue App ID","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"catalogId","in":"path","description":"The STAC catalog ID (only differs when the STAC catalog is proxied behind the FarEarth App)","required":true,"schema":{"type":"string"},"example":"farearth.gateway"},{"name":"collectionId","in":"path","description":"The STAC collection ID","required":true,"schema":{"type":"string"},"example":"farearth.sentinel-l1c"},{"name":"featureId","in":"path","description":"The STAC feature ID","required":true,"schema":{"type":"string"},"example":"S2A_34HBH_20240227_0_L1C"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StacItem"}}}},"404":{"description":"STAC item not found"},"503":{"description":"STAC catalog not found or unavailable"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/stac/api/ext/v1/stac/conformance":{"get":{"tags":["STAC endpoint"],"summary":"Server conformance endpoint","description":"Return STAC server conformance endpoint.","operationId":"getServerConformance","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StacConformance"}}}},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/orders/order/{order}/jobs":{"get":{"tags":["Order endpoints"],"summary":"Get order jobs","description":"Get the jobs for the given order.","operationId":"getJobs","parameters":[{"name":"order","in":"path","required":true,"schema":{"type":"string"},"example":"AAAA-0001"}],"responses":{"200":{"description":"A list of jobs","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Job"}}}}},"403":{"description":"Invalid order ID or wrong subscription"},"404":{"description":"Order not found"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/apps":{"get":{"tags":["App list endpoint"],"summary":"Get subscription apps","description":"Get a page of apps available to the current subscription.","operationId":"getApps","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}},{"name":"type","in":"query","required":false,"schema":{"type":"string","default":"Processor","enum":["Director","Datapoint","Catalogue","Processor"]}}],"responses":{"200":{"description":"A page of apps","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/workflows/list":{"get":{"tags":["Workflow list endpoint"],"summary":"Get workflows","description":"Get a page of workflows for the given app and current subscription.","operationId":"getWorkflows","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of workflows","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/workflows/files":{"get":{"tags":["Workflow list endpoint"],"summary":"Get workflow files","description":"Get a page of workflow files for the given app and current subscription.","operationId":"getWorkflowFiles","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of workflow files","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileItemsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/sensors/list":{"get":{"tags":["Sensor list endpoint"],"summary":"Get sensors","description":"Get a page of sensors for the given app and current subscription.","operationId":"getSensors","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of sensors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SensorsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/sensors/files":{"get":{"tags":["Sensor list endpoint"],"summary":"Get sensor files","description":"Get a page of sensor files for the given app and current subscription.","operationId":"getSensorFiles","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of sensor files","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileItemsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/secrets/list":{"get":{"tags":["Secrets list endpoint"],"summary":"Get secrets config files","description":"Get a page of secrets for the given app and current subscription.","operationId":"getSecretsConfigs","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of secrets config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/secrets/files":{"get":{"tags":["Secrets list endpoint"],"summary":"Get secrets config files","description":"Get a page of secrets config files for the given app and current subscription.","operationId":"getSecretsConfigFiles","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of secrets config files","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileItemsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/runtimes/list":{"get":{"tags":["Runtimes list endpoint"],"summary":"Get runtimes","description":"Get a page of processing runtimes for the given app and current subscription.","operationId":"getRuntimes","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of runtimes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuntimesPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/runtimes/files":{"get":{"tags":["Runtimes list endpoint"],"summary":"Get runtime files","description":"Get a page of processing runtime files for the given app and current subscription.","operationId":"getRuntimeFiles","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of runtime files","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileItemsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/pickups/list":{"get":{"tags":["Pickup list endpoint"],"summary":"Get pickups","description":"Get a page of pickups for the given app and current subscription.","operationId":"getPickups","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of pickups","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PickupsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/pickups/files":{"get":{"tags":["Pickup list endpoint"],"summary":"Get pickup files","description":"Get a page of pickup files for the given app and current subscription.","operationId":"getPickupFiles","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of pickup files","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileItemsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/hubItems/list":{"get":{"tags":["Hub item list endpoint"],"summary":"Get hub items","description":"Get a page of hub items for the given app and current subscription.","operationId":"getHubItems","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of hub items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HubItemsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/hubItems/files":{"get":{"tags":["Hub item list endpoint"],"summary":"Get hub item files","description":"Get a page of hub item files for the given app and current subscription.","operationId":"getHubItemFiles","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of hub item files","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileItemsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/executors/list":{"get":{"tags":["Executor list endpoint"],"summary":"Get executors","description":"Get a page of executors for the given app and current subscription.","operationId":"getExecutors","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of executors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutorsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/executor/{executorId}":{"get":{"tags":["Executor CRUD endpoints"],"summary":"Get executor","description":"Get a executor","operationId":"getExecutor","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"executorId","in":"path","required":true,"schema":{"type":"string"},"example":"trueorbit.my-executor"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Executor"}}}},"404":{"description":"Executor not found"},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/eventOutputs/list":{"get":{"tags":["Event output list endpoint"],"summary":"Get event output configfiles","description":"Get a page of event outputs for the given app and current subscription.","operationId":"getEventOutputConfigs","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of event output config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventOutputsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/eventOutputs/files":{"get":{"tags":["Event output list endpoint"],"summary":"Get event output config files","description":"Get a page of event output config files for the given app and current subscription.","operationId":"getEventOutputConfigFiles","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of event output config files","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileItemsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/dataHosts/list":{"get":{"tags":["Data host list endpoint"],"summary":"Get data hosts","description":"Get a page of data hosts for the given app and current subscription.","operationId":"getDataHosts","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of data hosts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataHostsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/dataHosts/files":{"get":{"tags":["Data host list endpoint"],"summary":"Get data host files","description":"Get a page of data host files for the given app and current subscription.","operationId":"getDataHostFiles","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of data host files","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileItemsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/collections/list":{"get":{"tags":["Collection list endpoint"],"summary":"Get collections","description":"Get a page of collections for the given app and current subscription.","operationId":"getCollections","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of collections","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/collections/files":{"get":{"tags":["Collection list endpoint"],"summary":"Get collection files","description":"Get a page of collection files for the given app and current subscription.","operationId":"getCollectionFiles","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of collection files","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileItemsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/archives/list":{"get":{"tags":["Archive list endpoint"],"summary":"Get archives","description":"Get a page of archives for the given app and current subscription.","operationId":"getArchives","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of archives","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchivesPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}},"/api/ext/v1/app/{app}/archives/files":{"get":{"tags":["Archive list endpoint"],"summary":"Get archive files","description":"Get a page of archive files for the given app and current subscription.","operationId":"getArchiveFiles","parameters":[{"name":"app","in":"path","required":true,"schema":{"type":"string"},"example":"farearth.gateway-bundled-dl"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"A page of archive files","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileItemsPage"}}}},"403":{"description":"Invalid subscription"},"401":{"description":"Unauthorized"}}}}},"components":{"schemas":{"ExecutorRequirements":{"type":"object","properties":{"input":{"description":"Executor input requirements.","title":"Step Executor Input"},"output":{"description":"Executor output requirements.","title":"Step Executor Output"},"tags":{"description":"Executor tag requirements.","title":"Step Executor Tags"}}},"Step":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the step. Must be unique per workflow.","title":"Step ID"},"displayName":{"type":"string","description":"The display name of the step.","title":"Step Display Name"},"description":{"type":"string","description":"The display name of the step.","title":"Step Description"},"executorId":{"type":"string","description":"The executor ID, unique per FarEarth Node app. So this step can be assigned to an executor with this ID if the capabilities match what is required for the step.","title":"Step Executor ID"},"executorVersion":{"type":"string","description":"The version of the executor to use. The latest version of the executor is used if not specified.","title":"Step Executor Version"},"executorType":{"type":"string","description":"The type of the executor to use.","title":"Step Executor Type"},"executorRequirements":{"$ref":"#/components/schemas/ExecutorRequirements","description":"The executor requirements used to search for an executor if an executor ID is not specified.","title":"Step Executor Requirements"},"inputs":{"description":"The selected input options from the possible inputs defined in the executor capabilities.","title":"Step Inputs"},"parameters":{"description":"Parameters that may be required by the job executor.","title":"Step Parameters"},"multi":{"type":"boolean","description":"Whether multiple Jobs can be created for this step based on outputs of previous steps (e.g. scene processing for unknown amount of scenes beforehand).","title":"Multi"},"optional":{"type":"boolean","description":"Whether the order should fail if any of the jobs in this step fails.","title":"Optional"},"continueOnFail":{"type":"boolean","description":"Whether to continue processing jobs for this step and child steps if a job failed.","title":"Continue On Fail"}},"required":["id"]},"Workflow":{"type":"object","properties":{"id":{"type":"string","description":"ID of the workflow.","example":"trueorbit.my-workflow","title":"Workflow ID"},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Tags.","example":{},"title":"Tags"},"displayName":{"type":"string","description":"Display name for the workflow.","example":"My Workflow","title":"Workflow Display Name"},"description":{"type":"string","description":"Description of the workflow.","example":"A test workflow","title":"Workflow Description"},"steps":{"type":"array","description":"Steps of the workflow.","example":[{"id":"0","executorId":"farearth.diagnostics","parameters":{"cpu":{}}}],"items":{"$ref":"#/components/schemas/Step"},"title":"Workflow Steps"},"paths":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Paths that chain steps of the workflow together.","example":{},"title":"Workflow Paths"}},"required":["displayName","id"]},"Band":{"type":"object","properties":{"name":{"type":"string","description":"Display name of the band.","title":"Band Name"},"center":{"type":"string","description":"The band center frequency.","title":"Band Center"},"bandwidth":{"type":"string","description":"The band frequency width.","title":"Band Width"}},"required":["bandwidth","center","name"]},"Sensor":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sensor.","example":"trueorbit.my-sensor","title":"Sensor ID"},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Tags.","example":{},"title":"Tags"},"name":{"type":"string","description":"Display name of the sensor.","example":"My Sensor","title":"Sensor Name"},"vendorId":{"type":"string","description":"ID of the sensor vendor.","example":"True Orbit","title":"Vendor ID"},"bands":{"type":"array","description":"The sensor frequency bands.","example":[{"name":"Blue","center":485,"bandwidth":70},{"name":"Green","center":560,"bandwidth":80},{"name":"Red","center":660,"bandwidth":60}],"items":{"$ref":"#/components/schemas/Band"},"title":"Sensor Bands"}},"required":["bands","id","name"]},"SecretsConfig":{"type":"object","properties":{"id":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Tags.","example":{},"title":"Tags"},"providerId":{"type":"string","description":"The ID of the secrets provider to be used (e.g., 'aws', 'hashicorp', 'infisical', etc.)","example":"aws","title":"Secrets provider ID"},"description":{"type":"string","description":"Description for the resource.","example":"My resource","title":"Description"},"properties":{"type":"object","additionalProperties":{},"description":"The provider specific configuration properties.","example":{},"title":"Provider properties"},"deactivated":{"type":"boolean","description":"Whether the secrets provider is deactivated. If deactivated, the provider will not be created nor used.","example":false,"title":"Deactivated"}},"required":["properties","providerId"],"title":"Secrets config"},"Runtime":{"type":"object","properties":{"id":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Tags.","example":{},"title":"Tags"},"type":{"type":"string","description":"Image processing runtime type (e.g., 'kubernetes', 'java-classpath' or 'java-cmdline'.","example":"kubernetes","title":"Type"},"properties":{"description":"Type specific properties unique to the runtime reflected by 'type'.","example":{"storeDirectory":"trueorbit.my-pickup"},"title":"Runtime Properties"},"enabledExecutors":{"type":"array","description":"A list of executors that will be enabled on the runtime (in the form 'executor:1.0.0').","items":{"type":"string"},"title":"List of enabled executors","uniqueItems":true},"maxJobs":{"type":"integer","format":"int32","description":"The maximum number of concurrent jobs allowed to be executed on the runtime.","title":"Max jobs"},"deactivated":{"type":"boolean","description":"Whether the runtime is deactivated. If deactivated, the runtime will not try to connect to external services such as clusters.","example":false,"title":"Deactivated"}},"required":["type"],"title":"Runtime"},"DataStoreLimits":{"type":"object","properties":{"capacity":{"type":"string","description":"The data store max capacity.","example":"100GB","title":"Capacity"},"garbageCollectionSortingProperties":{"type":"object","additionalProperties":{"type":"string","enum":["asc","desc"],"title":"Acending or descending direction"},"description":"The properties to be used for sorting.","example":{"created":"asc"},"title":"Garbage Collection Sorting Properties"},"warnOnRemaining":{"type":"string","description":"Remaining capacity when warning will be displayed.","example":"20GB","title":"Warn On Remaining"},"errorOnRemaining":{"type":"string","description":"Remaining capacity when error will be displayed.","example":"10GB","title":"Error On Remaining"}}},"Pickup":{"type":"object","properties":{"id":{"type":"string","description":"ID of the pickup.","example":"trueorbit.my-pickup","title":"Pickup ID"},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Tags.","example":{},"title":"Tags"},"displayName":{"type":"string","description":"Display name for the resource.","example":"My resource","title":"Display Name"},"protocol":{"type":"string","description":"The data access protocol to use.","example":"filesystem","title":"Protocol"},"priority":{"type":"integer","format":"int32","description":"Whether to choose this pickup above others if more than one is available (a lower value has higher priority).","example":100,"title":"Pickup Priority"},"properties":{"description":"The data access properties for this pickup.","example":{"storeDirectory":"trueorbit.my-pickup"},"title":"Pickup Properties"},"dataStoreLimits":{"$ref":"#/components/schemas/DataStoreLimits","description":"The properties for this data store.","title":"Data Store Limits"},"dataRetentionWindow":{"type":"string","description":"Data older than this window will be deleted.","example":12,"title":"Data Retention Window"},"prefix":{"type":"string","description":"Relative path prefix (can be templated with product properties).","example":"{year}/{spacecraft}/data/{guid}","title":"Prefix"},"rootPath":{"type":"string","description":"Root path where under all files will be read/write from.","example":"Data/testing/","title":"Root path"},"readOnly":{"type":"boolean","description":"Whether the storage medium can only be read and not written (nor deleted).","example":false,"title":"Read-only"},"overwriteExisting":{"type":"boolean","description":"Whether existing files should be overwritten.","example":false,"title":"Overwrite existing files"},"accessModes":{"type":"array","description":"Whether other data clients is allowed to pull or request a push to themselves","example":"['PUSH', 'PULL']","items":{"type":"string"},"title":"Supported access modes","uniqueItems":true},"retries":{"type":"integer","format":"int32","description":"The number of times an I/O operation should be retried before failing (defaults to 5 ms)","example":5,"title":"Retries upon failure"},"backoffDelay":{"type":"integer","format":"int32","description":"The number of milliseconds to wait before retrying a failed I/O operation (defaults to 1000 ms)","example":1000,"title":"Backoff delay before retrying"},"triggers":{"type":"array","items":{"description":"Trigger(s) used to detect new products.","example":[{"id":"FILE_MANIFEST","suffix":"_manifest.txt"}],"title":"Pickup Triggers"}},"attachParameters":{"description":"Parameters to attach to the order parameters.","example":{},"title":"Pickup Attach Parameters"},"attachProperties":{"description":"Properties to attach to the pickup files.","example":{},"title":"Pickup Attach Properties"},"skipTriggerFolderListing":{"type":"boolean","description":"Whether to include sibling files in trigger evaluations.","example":false,"title":"Skip folder listing"},"runAsSubscription":{"type":"string","description":"The subscription ID for orders triggered by this pickup.","example":"trueorbit","title":"Run As Subscription"},"deactivated":{"type":"boolean","description":"Whether the pickup is deactivated. If deactivated, the pickup triggers will not be started.","example":false,"title":"Deactivated"}},"required":["id","protocol"],"title":"Pickup"},"HubItem":{"type":"object","properties":{"id":{"type":"string","description":"ID of the hub item.","example":"trueorbit.my-hub-item","title":"Hub Item ID"},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Tags.","example":{},"title":"Tags"},"type":{"type":"string","description":"Type of the hub item.","enum":["Processing","Maintenance"],"example":"Processing","title":"Hub Item Type"},"title":{"type":"string","description":"Title of the hub item.","example":"My Hub Item","title":"Hub Item Title"},"description":{"type":"string","description":"Description of the hub item.","example":"A test hub item","title":"Hub Item Description"},"imageUrl":{"type":"string","description":"Image URL of the hub item.","title":"Hub Item Image URL"},"wizardId":{"type":"string","description":"Wizard used by the hub item.","example":"default","title":"Hub Item Wizard ID"},"workflowId":{"type":"string","description":"Workflow used by the hub item.","example":"trueorbit.my-workflow","title":"Hub Item Workflow ID"},"subscriptionTypes":{"type":"array","description":"Subscription types that can use the hub item.","example":["User","Group"],"items":{"type":"string"},"title":"Hub Item Subscription Types","uniqueItems":true},"priority":{"type":"integer","format":"int32","description":"Priority used to sort hub items.","example":100,"title":"Hub Item Priority"}},"required":["id","title","type","wizardId"]},"BulkOrderCompletedEventConfig":{"type":"object","properties":{"filterStatus":{"type":"array","items":{"type":"string","enum":["QUEUED","BUSY","WAITING","HELP","FINALISING","SUCCESS","CANCELLED","FAILED"],"title":"Order Status"},"uniqueItems":true}}},"DataArchivedEventConfig":{"title":"Data archived event configuration"},"EventOutputConfig":{"type":"object","properties":{"id":{"type":"string","description":"ID of the event output.","example":"trueorbit.my-event-output","title":"Event output ID"},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Tags.","example":{},"title":"Tags"},"type":{"type":"string","description":"The type of event output.","example":"amazon-sqs","title":"Event output type"},"description":{"type":"string","description":"Description for the resource.","example":"My resource","title":"Description"},"orderActivityConfig":{"$ref":"#/components/schemas/OrderActivityEventConfig","title":"Order activity event config"},"orderCompletedConfig":{"$ref":"#/components/schemas/OrderCompletedEventConfig","title":"Order completed event config"},"bulkOrderCompletedConfig":{"$ref":"#/components/schemas/BulkOrderCompletedEventConfig","title":"Bulk order completed event config"},"dataArchivedConfig":{"$ref":"#/components/schemas/DataArchivedEventConfig","title":"Data archived event config"},"outputProperties":{"type":"object","additionalProperties":{},"description":"The type of event output.","example":{},"title":"Event output type"},"deactivated":{"type":"boolean","description":"Whether the event output is deactivated. If deactivated, the output will not be created nor used.","example":false,"title":"Deactivated"},"retries":{"type":"integer","format":"int32","example":5,"title":"Retries"},"backoffDelay":{"type":"integer","format":"int32","example":1000,"title":"Backoff delay"},"window":{"type":"string","example":"15s","title":"Batching window delay in the format '1h 15m 23s'. Defaults to disabled."}},"required":["id","outputProperties","type"],"title":"Event output config"},"OrderActivityEventConfig":{"title":"Order activity event configuration"},"OrderCompletedEventConfig":{"type":"object","properties":{"filterStatus":{"type":"array","items":{"type":"string","enum":["QUEUED","BUSY","WAITING","HELP","FINALISING","SUCCESS","CANCELLED","FAILED"],"title":"Order Status"},"uniqueItems":true},"filterWorkflows":{"type":"array","items":{"type":"string"},"uniqueItems":true}},"title":"Order completed event configuration"},"DataHost":{"type":"object","properties":{"id":{"type":"string","description":"ID of the data host.","example":"trueorbit.my-data-host","title":"Data Host ID"},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Tags.","example":{},"title":"Tags"},"displayName":{"type":"string","description":"Display name for the resource.","example":"My resource","title":"Display Name"},"protocol":{"type":"string","description":"The data access protocol to use.","example":"filesystem","title":"Protocol"},"priority":{"type":"integer","format":"int32","description":"Whether to choose this pickup above others if more than one is available (a lower value has higher priority).","example":100,"title":"Data Host Priority"},"properties":{"description":"The data access properties for this data host.","example":{"storeDirectory":"trueorbit.my-data-host"},"title":"Data Host Properties"},"dataStoreLimits":{"$ref":"#/components/schemas/DataStoreLimits","description":"The properties for this data store.","title":"Data Store Limits"},"dataRetentionWindow":{"type":"string","description":"Data older than this window will be deleted.","example":12,"title":"Data Retention Window"},"prefix":{"type":"string","description":"Relative path prefix (can be templated with product properties).","example":"{year}/{spacecraft}/data/{guid}","title":"Prefix"},"rootPath":{"type":"string","description":"Root path where under all files will be read/write from.","example":"Data/testing/","title":"Root path"},"readOnly":{"type":"boolean","description":"Whether the storage medium can only be read and not written (nor deleted).","example":false,"title":"Read-only"},"overwriteExisting":{"type":"boolean","description":"Whether existing files should be overwritten.","example":false,"title":"Overwrite existing files"},"accessModes":{"type":"array","description":"Whether other data clients is allowed to pull or request a push to themselves","example":"['PUSH', 'PULL']","items":{"type":"string"},"title":"Supported access modes","uniqueItems":true},"retries":{"type":"integer","format":"int32","description":"The number of times an I/O operation should be retried before failing (defaults to 5 ms)","example":5,"title":"Retries upon failure"},"backoffDelay":{"type":"integer","format":"int32","description":"The number of milliseconds to wait before retrying a failed I/O operation (defaults to 1000 ms)","example":1000,"title":"Backoff delay before retrying"}},"required":["id","protocol"],"title":"Data Host"},"Collection":{"type":"object","properties":{"details":{"$ref":"#/components/schemas/CollectionDetails","description":"Collection details.","title":"Details"},"filter":{"$ref":"#/components/schemas/SearchDetails","description":"Collection search filter.","title":"Search Details"},"proxy":{"$ref":"#/components/schemas/ProxyDetails","description":"Collection proxy details.","title":"Proxy Details"}},"required":["details"],"title":"Collection"},"CollectionDetails":{"type":"object","properties":{"id":{"type":"string","description":"ID of the collection.","example":"trueorbit.my-collection","title":"Collection ID"},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Tags.","example":{},"title":"Tags"},"title":{"type":"string","description":"Title of the collection.","example":"My Collection","title":"Title"},"description":{"type":"string","description":"Description of the collection.","example":"Collection of products","title":"Description"},"hidden":{"type":"boolean","description":"Whether the collection is hidden in the Catalogue.","example":false,"title":"Hidden"}},"required":["id","title"]},"ProxyDetails":{"type":"object","properties":{"sourceId":{"type":"string"},"sourceTitle":{"type":"string"},"baseUrl":{"type":"string"},"httpHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"SearchDetails":{"type":"object","properties":{"bbox":{"type":"array","description":"Only return items that intersect the provided bounding box.","example":[160.6,-55.95,-170,-25.89],"items":{"type":"number","format":"double"}},"datetime":{"type":"string","description":"An interval such as '2018-02-12T23:20:50Z', or '2018-02-12T00:00:00Z/2018-03-18T12:31:12Z', or '2018-02-12T00:00:00Z/..' or '../2018-03-18T12:31:12Z'","example":"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"},"intersects":{"type":"object","additionalProperties":{},"description":"Only return items that intersect with the provided GeoJSON geometry."},"collections":{"type":"array","description":"Search against the collection ID's provided","items":{"type":"string"}},"ids":{"type":"array","description":"Only returns items that match the given ids","example":"[S2A_34HBH_20240227_0_L1C, S2A_34HBJ_20240227_0_L1C]","items":{"type":"string"}},"limit":{"type":"integer","format":"int32","description":"Only returns maximum number of results (page size)","example":15},"fields":{"$ref":"#/components/schemas/SearchFields","description":"Only include or exclude the provided field IDs","example":15},"query":{"description":"The search query."},"sortby":{"type":"array","description":"Sort the results by the specified fields either ascending or descending","items":{"$ref":"#/components/schemas/SortPair"}},"catalog":{"type":"string"},"next":{"type":"string"},"page":{"type":"integer","format":"int32"}},"title":"STAC POST search parameters"},"SearchFields":{"type":"object","properties":{"include":{"type":"array","description":"A list of fields that will be included in the search","items":{"type":"string"}},"exclude":{"type":"array","description":"A list of fields that will be excluded from the search","items":{"type":"string"}}},"title":"STAC field inclusion/exclusion"},"SortPair":{"type":"object","properties":{"field":{"type":"string","description":"The field ID to sort by"},"direction":{"type":"string","description":"Whether to sort ascending or descending","enum":["asc","desc"],"title":"Acending or descending direction"}},"title":"STAC search field sorting"},"Archive":{"type":"object","properties":{"id":{"type":"string","description":"ID of the archive.","example":"trueorbit.my-archive","title":"Archive ID"},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Tags.","example":{},"title":"Tags"},"displayName":{"type":"string","description":"Display name for the resource.","example":"My resource","title":"Display Name"},"protocol":{"type":"string","description":"The data access protocol to use.","example":"filesystem","title":"Protocol"},"priority":{"type":"integer","format":"int32","description":"Whether to choose this archive above others if their capabilities match (a lower value has higher priority).","example":100,"title":"Archive Executor Priority"},"properties":{"description":"The data access properties for this archive.","example":{"storeDirectory":"trueorbit.my-archive"},"title":"Archive Properties"},"dataStoreLimits":{"$ref":"#/components/schemas/DataStoreLimits","description":"The properties for this data store.","title":"Data Store Limits"},"dataRetentionWindow":{"type":"string","description":"Data older than this window will be deleted.","example":12,"title":"Data Retention Window"},"prefix":{"type":"string","description":"Relative path prefix (can be templated with product properties).","example":"{year}/{spacecraft}/data/{guid}","title":"Prefix"},"rootPath":{"type":"string","description":"Root path where under all files will be read/write from.","example":"Data/testing/","title":"Root path"},"readOnly":{"type":"boolean","description":"Whether the storage medium can only be read and not written (nor deleted).","example":false,"title":"Read-only"},"overwriteExisting":{"type":"boolean","description":"Whether existing files should be overwritten.","example":false,"title":"Overwrite existing files"},"accessModes":{"type":"array","description":"Whether other data clients is allowed to pull or request a push to themselves","example":"['PUSH', 'PULL']","items":{"type":"string"},"title":"Supported access modes","uniqueItems":true},"retries":{"type":"integer","format":"int32","description":"The number of times an I/O operation should be retried before failing (defaults to 5 ms)","example":5,"title":"Retries upon failure"},"backoffDelay":{"type":"integer","format":"int32","description":"The number of milliseconds to wait before retrying a failed I/O operation (defaults to 1000 ms)","example":1000,"title":"Backoff delay before retrying"},"attachProperties":{"description":"Properties to attach to the archived files.","example":{},"title":"Archive Attach Properties"},"capabilities":{"type":"array","description":"Capabilities that can be used to select the correct archive based on input data","example":{},"items":{"$ref":"#/components/schemas/Capability"},"title":"Archive Executor Capabilities"},"auxFileGenerators":{"type":"array","items":{"description":"Generators that attaches auxilliary file to archived products.","example":[{"id":"PRODUCT_FILE_JSON","relativePathTemplate":"/data/{spacecraft}/{year}/data_product.json"}],"title":"Auxiliary file generator configs"}},"maxJobs":{"type":"integer","format":"int32","description":"The maximum number of concurrent jobs allowed to run against this archive.","example":100,"title":"Max concurrent jobs"},"filters":{"type":"array","items":{"description":"A set of filters that allow including, excluding or renaming input files.","example":[],"title":"Archive filters"}}},"required":["id","protocol"],"title":"Archive"},"Capability":{"type":"object","properties":{"id":{"type":"string"},"input":{"type":"object","additionalProperties":{},"properties":{"empty":{"type":"boolean"}}},"output":{"type":"object","additionalProperties":{},"properties":{"empty":{"type":"boolean"}}},"cost":{"$ref":"#/components/schemas/Cost"},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Parameter"}}}},"Cost":{"type":"object","properties":{"value":{"type":"integer","format":"int32"}}},"Option":{"type":"object","properties":{"parameter":{},"cost":{"$ref":"#/components/schemas/Cost"}}},"Parameter":{"type":"object","properties":{"options":{"type":"array","items":{"$ref":"#/components/schemas/Option"}},"selected":{}}},"StacContext":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page number (starting at 1)"},"limit":{"type":"integer","format":"int32","description":"The size of the page (max 15)"},"matched":{"type":"integer","format":"int32","description":"The total number of items matching the original search criteria (unreliable for very large search results)"},"returned":{"type":"integer","format":"int32","description":"The total number of items return for this search"}},"required":["limit","matched","page","returned"],"title":"Paging state"},"StacItem":{"type":"object","description":"A GeoJSON Feature augmented with foreign members that contain values relevant to a STAC entity","properties":{"type":{"type":"string","description":"The GeoJSON type of the object","example":"Feature"},"id":{"type":"string","description":"The ID of the feature","example":"S2A_34HBH_20240227_0_L1C"},"assets":{"type":"object","additionalProperties":{},"description":"The file assets associated with the item"},"bbox":{"type":"array","description":"Minimum bounding box that includes the outline of all assets in sequence [minX, minY, maxX, maxY] (in CRS WGS84 longitude/latitude, where axis X-Y equals axis long-lat). The bounding box of the New Zealand Exclusive Economic Zone in WGS 84 (from 160.6°E to 170°W and from 55.95°S to 25.89°S) would be represented in JSON as `[160.6, -55.95, -170, -25.89]`","example":[160.6,-55.95,-170,-25.89],"items":{"type":"number","format":"double"}},"geometry":{"description":"The GeoJSON geometry of the item","example":"{'type': 'Point', 'coordinates': [30.52,12.64]}"},"properties":{"description":"Any additional properties added in via Item specification or extensions."},"links":{"type":"array","description":"Links to other resources related to this item.","items":{"$ref":"#/components/schemas/StacLink"}},"stac_version":{"type":"string","description":"The STAC schema version","example":"1.0.0"}},"required":["assets","bbox","geometry","id","links","properties","stac_version","type"],"title":"STAC item"},"StacItemCollection":{"type":"object","properties":{"type":{"type":"string","description":"The GeoJSON type of the object (always 'FeatureCollection')","example":"FeatureCollection"},"features":{"type":"array","description":"A list of GeoJSON Features augmented with foreign members that contain values relevant to a STAC entity","items":{"$ref":"#/components/schemas/StacItem"}},"links":{"type":"array","description":"Links to other resources related to this item.","items":{"$ref":"#/components/schemas/StacLink"}},"context":{"$ref":"#/components/schemas/StacContext","description":"Paging search state"}},"required":["features","type"],"title":"STAC item collection"},"StacLink":{"type":"object","properties":{"href":{"type":"string","description":"The location of the resource.","example":"https://landsatlook.usgs.gov/stac-server/collections/landsat-c2l2-sr"},"rel":{"type":"string","description":"Relation type of the link (examples include self, 'root', 'parent', 'child' ('catalog' or 'collection'), 'search', 'item' (URL to stac item), 'next', 'prev').","example":"next"},"type":{"type":"string","description":"The media MIME type of the resource.","example":"text/html"},"title":{"type":"string","description":"Title of the resource","example":"A link to the next page"},"method":{"type":"string","description":"Specifies the HTTP method that the resource expects ('GET' or 'POST')","example":"GET"},"headers":{"type":"object","additionalProperties":{"type":"string"},"description":"Object key values pairs they map to headers."},"body":{"description":"For POST requests, the resource can specify the HTTP body as a JSON object."},"merge":{"type":"boolean","description":"This is only valid when the server is responding to POST request. If merge is true, the client is expected to merge the body value into the current request body before following the link.","example":false}},"required":["href","rel"],"title":"STAC link"},"SearchNextBody":{"type":"object","properties":{"data":{"type":"string"}}},"ReadyData":{"type":"object","description":"The relevant ready data, which includes the STAC input as well as optionally any order parameters to inject in the resulting order.","properties":{"input":{"$ref":"#/components/schemas/StacItem","description":"The metadata associated with the pickup input. The asset hrefs should be realtive within the storage medium.","title":"Input data"},"orderParameters":{"description":"Customization of order parameters (such as specifying a 'workflowId'.","example":{},"title":"Order parameters"}},"required":["input"],"title":"Ready data"},"OrderFilter":{"type":"object","properties":{"searchText":{"type":"string","description":"Text to search for when matching orders.","example":"AAAA-0001","title":"Search Text"},"from":{"type":"integer","format":"int64","description":"Filter out orders that completed before this time in UTC milliseconds.","example":0,"title":"From Time"},"to":{"type":"integer","format":"int64","description":"Filter out orders that started after this time in UTC milliseconds.","example":5000000000000,"title":"To Time"}},"title":"Order Filter"},"Order":{"type":"object","properties":{"subscriptionId":{"type":"string","description":"The ID of the subscription that owns the order.","example":"trueorbit","title":"Subscription ID"},"id":{"type":"string","description":"The ID of the order.","example":"AAAA-0001","title":"Order ID"},"createdMillis":{"type":"integer","format":"int64","description":"The creation time of the order in UTC milliseconds.","example":1700000000000,"title":"Created Time"},"startMillis":{"type":"integer","format":"int64","description":"The start time of the order in UTC milliseconds.","example":1700000010000,"title":"Start Time"},"endMillis":{"type":"integer","format":"int64","description":"The end time of the order in UTC milliseconds.","example":1700000020000,"title":"End Time"},"status":{"type":"string","description":"The current order status.","enum":["QUEUED","BUSY","WAITING","HELP","FINALISING","SUCCESS","CANCELLED","FAILED"],"example":"SUCCESS","title":"Status"},"error":{"type":"string","description":"Failure reason if order failed before any jobs were created.","title":"Error"},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value tags associated with the order.","example":{},"title":"Tags"}},"required":["createdMillis","id","status","subscriptionId"],"title":"Order"},"OrdersPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/Order"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"AppVersion":{"type":"object","properties":{"version":{"type":"string","description":"Application version.","example":"3.14.1","title":"Version"},"buildNumber":{"type":"string","description":"Unique build identifier number.","example":"eabf8dc","title":"Build number"},"buildTime":{"type":"string","description":"Whether the resource is usable.","example":"2024-02-14T12:48:45Z","title":"Build time"},"uptime":{"type":"string","description":"The up-time of the server.","example":1,"title":"Up-time"},"currentTime":{"type":"string","description":"Current server UTC time.","example":"2024-02-14T12:48:45Z","title":"Current time"}},"required":["buildNumber","buildTime","currentTime","uptime","version"]},"User":{"type":"object","properties":{"email":{"type":"string","description":"Email address that uniquely identifies the user.","example":"john.doe@example.com","title":"User Email Address"},"givenName":{"type":"string","description":"First name(s) of the user.","example":"John","title":"User First Name(s)"},"familyName":{"type":"string","description":"Last name of the user.","example":"Doe","title":"User Surname"}},"required":["email"],"title":"User"},"UsersPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/User"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"StacLandingPage":{"type":"object","properties":{"type":{"type":"string","description":"The type of object (always 'Catalog')","example":"Catalog"},"id":{"type":"string","description":"The STAC Catalog ID","example":"farearth-catalog"},"title":{"type":"string","description":"Displayed title of the Catalog","example":"FarEarth Catalog"},"description":{"type":"string","description":"A long description of the contents and purpose of the Catalog","example":"FarEarth Catalog"},"links":{"type":"array","description":"Links to other resources available in the Catalog (such as other Catalogs, collections, API references, and other metadata)","example":"Links to collections","items":{"$ref":"#/components/schemas/StacLink"}},"conformsTo":{"type":"array","description":"A list of all conformance classes implemented by the server.","items":{"type":"string"}},"stac_version":{"type":"string","description":"The STAC schema version","example":"1.0.0"},"stac_extensions":{"type":"array","description":"A list of supported STAC extensions","example":"Description of the extensions","items":{"type":"string"}}},"required":["conformsTo","description","id","links","stac_version","type"],"title":"STAC landing page"},"StacCatalog":{"type":"object","properties":{"type":{"type":"string","description":"The type of object (always 'Catalog')","example":"Catalog"},"id":{"type":"string","description":"The STAC Catalog ID","example":"farearth-catalog"},"title":{"type":"string","description":"Displayed title of the Catalog","example":"FarEarth Catalog"},"description":{"type":"string","description":"A long description of the contents and purpose of the Catalog","example":"FarEarth Catalog"},"links":{"type":"array","description":"Links to other resources available in the Catalog (such as other Catalogs, collections, API references, and other metadata)","example":"Links to collections","items":{"$ref":"#/components/schemas/StacLink"}},"conformsTo":{"type":"array","description":"A list of all conformance classes implemented by the server.","items":{"type":"string"}},"stac_version":{"type":"string","description":"The STAC schema version","example":"1.0.0"},"stac_extensions":{"type":"array","description":"A list of supported STAC extensions","example":"Description of the extensions","items":{"type":"string"}}},"required":["conformsTo","description","id","links","stac_version","type"],"title":"STAC catalog"},"StacConformance":{"type":"object","properties":{"conformsTo":{"type":"array","description":"A list of conformance specifications","items":{"type":"string"}}},"required":["conformsTo"],"title":"STAC conformance"},"StacCollection":{"type":"object","properties":{"type":{"type":"string","description":"The type of object (always 'Collection')","example":"Collection"},"id":{"type":"string","description":"The ID of the collection in question","example":"demosat1-collection"},"title":{"type":"string","description":"The title of the collection","example":"A descriptive title"},"description":{"type":"string","description":"A long description of the collection describing it's composition and purpose","example":"A long description"},"license":{"type":"string","description":"The license associated with the collection","example":"Apache-2.0"},"keywords":{"type":"array","description":"List of keywords describing the collection","example":"[HSI, MSI]","items":{"type":"string"}},"providers":{"type":"array","description":"A list of providers, which may include all organizations capturing or processing the data or the hosting provider.","items":{"$ref":"#/components/schemas/StacProvider"}},"links":{"type":"array","description":"Links to other resources available in this collection","items":{"$ref":"#/components/schemas/StacLink"}},"extent":{"$ref":"#/components/schemas/StacExtent","description":"A summary of the spatial and temporal extent covering this collection"},"stac_version":{"type":"string","description":"The STAC schema version","example":"1.0.0"},"stac_extensions":{"type":"array","description":"A list of utilized STAC extensions","example":"A list of extensions used within this collection","items":{"type":"string"}}},"required":["description","extent","id","license","links","stac_version","type"],"title":"STAC collection"},"StacCollections":{"type":"object","properties":{"collections":{"type":"array","description":"List of collections","items":{"$ref":"#/components/schemas/StacCollection"}},"links":{"type":"array","description":"Links to other resources","items":{"$ref":"#/components/schemas/StacLink"}}},"required":["collections","links"],"title":"STAC collections"},"StacExtent":{"type":"object","properties":{"spatial":{"$ref":"#/components/schemas/StacSpatialExtent","description":"Spatial cover"},"temporal":{"$ref":"#/components/schemas/StacTemporalExtent","description":"Temporal cover"}},"required":["spatial","temporal"],"title":"STAC extent"},"StacProvider":{"type":"object","properties":{"name":{"type":"string","description":"The name of the organization or the individual","example":"USGS"},"roles":{"type":"array","description":"Roles of the provider. Examples include 'licensor', 'producer', 'processor', 'host'.","example":"producer","items":{"type":"string"}},"description":{"type":"string","description":"Multi-line description to add further provider information such as processing details for processors and producers, hosting details for hosts or basic contact information."},"url":{"type":"string","description":"Homepage on which the provider describes the dataset and publishes contact information."}},"required":["name"],"title":"STAC provider"},"StacSpatialExtent":{"type":"object","properties":{"bbox":{"type":"array","description":"Bounding boxes that describe the spatial extent of the dataset.","example":[-180,-90,180,90],"items":{"type":"number","format":"double"}},"crs":{"type":"string","description":"Coordinate reference system of the coordinates in the spatial extent with property `bbox`. WGS 84 longitude/latitude","example":"http://www.opengis.net/def/crs/OGC/1.3/CRS84"}},"required":["bbox"],"title":"STAC spatial extent"},"StacTemporalExtent":{"type":"object","properties":{"interval":{"type":"array","description":"One or more time intervals that describe the temporal extent of the dataset.","example":"[['2011-11-11T12:22:11Z', null]]","items":{"type":"array","items":{"type":"string"}}},"trs":{"type":"string","description":"Bounding box that describe the spatial extent of the dataset.","example":"http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"}},"required":["interval","trs"],"title":"STAC temporal extent"},"Job":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the job.","title":"Job ID"},"stepId":{"type":"string","description":"The workflow step ID of the job.","title":"Step ID"},"executorId":{"type":"string","description":"The ID of the executor the job was assigned to.","title":"Executor ID"},"capabilitiesId":{"type":"string","description":"The ID of the capabilities that matched to start the job.","title":"Capabilities ID"},"appId":{"type":"string","description":"The ID of the app that the job was assigned to.","title":"App ID"},"createdMillis":{"type":"integer","format":"int64","description":"The created time of the job in UTC milliseconds.","title":"Created Time"},"startMillis":{"type":"integer","format":"int64","description":"The start time of the job in UTC milliseconds.","title":"Start Time"},"endMillis":{"type":"integer","format":"int64","description":"The end time of the job in UTC milliseconds.","title":"End Time"},"jobState":{"$ref":"#/components/schemas/JobState","description":"The current state of the job.","title":"State"}},"required":["appId","capabilitiesId","createdMillis","executorId","id","jobState","stepId"],"title":"Job"},"JobState":{"type":"object","properties":{"status":{"type":"string","description":"The current job status.","enum":["ASSIGNED","BUSY","HELP","SUCCESS","CANCELLED","FAILED"],"title":"Status"},"progress":{"type":"number","format":"double","description":"Job progress percentage from 0 to 100.","title":"Progress"},"progressMessage":{"type":"string","description":"The current job status.","title":"Status"}},"required":["progress","status"],"title":"Job State"},"AppDto":{"type":"object","properties":{"id":{"type":"string"},"enabled":{"type":"boolean"},"online":{"type":"boolean"}}},"AppsPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/AppDto"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"WorkflowsPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/Workflow"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"FileItemDto":{"type":"object","properties":{"fileName":{"type":"string"},"size":{"type":"integer","format":"int64"},"itemId":{"type":"string"},"error":{"type":"string"}}},"FileItemsPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/FileItemDto"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"SensorsPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/Sensor"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"SecretsPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/SecretsConfig"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"RuntimesPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/Runtime"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"PickupsPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/Pickup"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"HubItemsPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/HubItem"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"Executor":{"type":"object","properties":{"id":{"type":"string","description":"ID of the executor.","example":"trueorbit.my-executor","title":"Executor ID"},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Tags.","example":{},"title":"Tags"},"displayName":{"type":"string","description":"Display name for the executor.","example":"My resource","title":"Display Name"},"capabilitiesId":{"type":"string","description":"Capabilities to use for this executor.","example":"my_executor","title":"Executor Capabilities ID"},"executorType":{"type":"string","description":"Type of the executor.","example":"java-cmdline","title":"Executor Type"},"executorVersion":{"type":"string","description":"Version of the executor.","example":"1.0.0","title":"Executor Version"}},"required":["capabilitiesId","executorType","executorVersion","id"],"title":"Executor"},"ExecutorsPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/Executor"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"EventOutputsPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/EventOutputConfig"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"DataHostsPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/DataHost"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"CollectionsPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/Collection"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]},"ArchivesPage":{"type":"object","properties":{"data":{"type":"array","description":"Items returned for the requested query parameters.","items":{"$ref":"#/components/schemas/Archive"},"title":"Page items"},"page":{"type":"integer","format":"int32","description":"Page number that was requested (which starts counting from 1).","title":"Page Number"},"limit":{"type":"integer","format":"int32","description":"Max amount of items per page.","title":"Page Limit"},"count":{"type":"integer","format":"int32","description":"Amount of items returned for this page.","title":"Page Item Count"},"total":{"type":"integer","format":"int64","description":"Amount of total items for all pages.","title":"Total Item Count"}},"required":["count","data","limit","page","total"]}},"securitySchemes":{"X-API-Key":{"type":"apiKey","description":"API Token","name":"X-API-Key","in":"header"}}}}