Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Expanso

Expanso Orchestrator API

The Orchestrator API from Expanso — 11 operation(s) for orchestrator.

Documentation Provider Profile APIs.io OpenAPI GitHub

Expanso Orchestrator API is one of 2 APIs that Expanso publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orchestrator. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 14 operations across 11 paths, and defines 58 schemas. It is described by OpenAPI 2.0.

Requests are made against the base URL https://cloud.expanso.io.

14 operations 11 paths 58 schemas 1 DELETE9 GET4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
Base URL
https://cloud.expanso.io
Contact
Bacalhau Team
License
Apache 2.0
Resource Areas
1

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 1 DELETE, 9 GET, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Orchestrator 14
GET
/api/v1/orchestrator/jobs
Returns a list of jobs.
orchestrator/listJobs 5 params → 200400500
PUT
/api/v1/orchestrator/jobs
Submits a job to the orchestrator.
orchestrator/putJob 1 param → 200400500
PUT
/api/v1/orchestrator/jobs/diff
Compares a job spec with an existing job of the same name.
orchestrator/diffJob 1 param → 200400500
GET
/api/v1/orchestrator/jobs/{id}
Returns a job.
orchestrator/getJob 4 params → 200400500
DELETE
/api/v1/orchestrator/jobs/{id}
Stops a job.
orchestrator/stopJob 2 params → 200400500
GET
/api/v1/orchestrator/jobs/{id}/executions
Returns the executions of a job.
orchestrator/jobExecutions 6 params → 200400500
GET
/api/v1/orchestrator/jobs/{id}/history
Returns the history of a job.
orchestrator/listHistory 6 params → 200400500
GET
/api/v1/orchestrator/jobs/{id}/logs
Streams the logs for a current job/execution via WebSocket
orchestrator/logs 4 params → 101400500
PUT
/api/v1/orchestrator/jobs/{id}/rerun
Reruns a job.
orchestrator/rerunJob 2 params → 200400500
GET
/api/v1/orchestrator/jobs/{id}/results
Returns the results of a job.
orchestrator/jobResults 1 param → 200400500
GET
/api/v1/orchestrator/jobs/{id}/versions
Returns the versions of a job.
orchestrator/jobVersions 6 params → 200400500
GET
/api/v1/orchestrator/nodes
Returns a list of orchestrator nodes.
orchestrator/listNodes 6 params → 200400500
GET
/api/v1/orchestrator/nodes/{id}
Get an orchestrator node
orchestrator/getNode 1 param → 200400404500
PUT
/api/v1/orchestrator/nodes/{id}
Update an orchestrator node.
orchestrator/updateNode 2 params → 200400404500

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are models.Execution (20 properties), models.Job (15 properties), models.ComputeNodeInfo (10 properties), models.Task (10 properties). Each schema is shown below with its type and property counts.

apimodels.PutNodeResponse
object
2 properties
models.ConnectionState
object
7 properties
models.ResultPath
object
2 properties
apimodels.GetJobResponse
object
3 properties
models.JobStateType
integer
models.ExecutionStateType
integer
apimodels.ListJobResultsResponse
object
2 properties
models.NodeType
integer
apimodels.ListNodesResponse
object
2 properties
models.StateChange-models_JobStateType
object
2 properties
models.ExecutionDesiredStateType
integer
models.Protocol
string
models.ComputeNodeInfo
object
10 properties
models.AllocatedResources
object
1 property
models.JobHistoryType
integer
apimodels.ListJobExecutionsResponse
object
2 properties
models.Network
integer
models.RunCommandResult
object
6 properties
apimodels.PutJobResponse
object
3 properties
apimodels.RerunJobRequest
object
5 properties
selection.Operator
string
models.NodeConnectionState
object
1 property
models.Event
object
4 properties
apimodels.ListJobVersionsResponse
object
2 properties
models.NodeMembershipState
object
1 property
models.StateChange-models_ExecutionStateType
object
2 properties
apimodels.ListJobsResponse
object
2 properties
models.ResourcesConfig
object
4 properties
models.LabelSelectorRequirement
object
3 properties
apimodels.PutNodeRequest
object
6 properties
models.Task
object
10 properties
models.SpecConfig
object
2 properties
models.Resources
object
5 properties
models.GPU
object
5 properties
apimodels.HTTPCredential
object
3 properties
apimodels.StopJobResponse
object
1 property
models.ExecutionLog
object
2 properties
models.GPUVendor
string
models.JobHistory
object
9 properties
apimodels.PutJobRequest
object
5 properties
models.ExecutionLogType
integer
models.State-models_ExecutionDesiredStateType
object
3 properties
models.Job
object
15 properties
models.Execution
object
20 properties
models.TimeoutConfig
object
3 properties
models.State-models_JobStateType
object
3 properties
apimodels.DiffJobResponse
object
2 properties
models.NodeState
object
4 properties
apimodels.RerunJobResponse
object
4 properties
models.NodeInfo
object
6 properties
models.State-models_ExecutionStateType
object
3 properties
models.NetworkConfig
object
3 properties
models.BuildVersionInfo
object
7 properties
models.Port
object
4 properties
apimodels.DiffJobRequest
object
4 properties
models.InputSource
object
3 properties
apimodels.GetNodeResponse
object
1 property
apimodels.ListJobHistoryResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

expanso-orchestrator-api-openapi.yml Raw ↑

Other APIs Expanso publishes across the network.

Expanso Ops API
AE Profile APIs.io
#Orchestrator
← Back to E APIs
API Details
ID
expanso:expanso-orchestrator-api
Base URL
https://cloud.expanso.io
Docs
https://bacalhau.org/docs/
Provider
Expanso
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network