Swagger UIswagger

Xene API server
 0.1.0 

[ Base URL: localhost:6060/ ]

Xene is the workflow creator and manager tool

api

GET/api/v1/authok
Handles ping event for api routes.

info

GET/api/v1/info/agent/{name}
Returns verbose information about the agent.
GET/api/v1/info/workflow/{workflow}/pipeline/{pipeline}
Returns verbose information about a workflow.
GET/api/v1/info/workflow/{workflow}/pipeline/{pipeline}/runs/{runID}
Returns verbose information about a pipeline run.
GET/api/v1/info/workflow/{workflow}/pipeline/{pipeline}/spec
Returns spec of the provided workflow pipeline.

registry

GET/api/v1/registry/agent
Returns the specified agent object from the store.
POST/api/v1/registry/agent
Creates a new agent in the store.
GET/api/v1/registry/agent/{name}
Returns the specified agent object from the store with the name in params.
DELETE/api/v1/registry/agent/{name}
Deletes the specified agent from the store.
PATCH/api/v1/registry/agent/{name}
Patches the specified agent from the store.
GET/api/v1/registry/list/agents
List all the keys of items in the registry of the provided type agent.
GET/api/v1/registry/list/secrets
List all the keys of items in the registry of the provided type agent.
GET/api/v1/registry/list/workflows
Gather information about all the workflow objects managed by xene.
GET/api/v1/registry/secret
Returns the specified secret object from the store.
POST/api/v1/registry/secret
Creates a new secret in the store.
GET/api/v1/registry/secret/{name}
Returns the specified secret object from the store with the name in params.
DELETE/api/v1/registry/secret/{name}
Deletes the specified secret from the store.
PATCH/api/v1/registry/secret/{name}
Patches the specified secret from the store.
GET/api/v1/registry/workflow
Returns the specified workflow object from the store.
POST/api/v1/registry/workflow
Creates a new workflow in the store.
GET/api/v1/registry/workflow/{name}
Returns the specified workflow object from the store with the name in params.
DELETE/api/v1/registry/workflow/{name}
Deletes the specified workflow from the store.
PATCH/api/v1/registry/workflow/{name}
Patches the specified workflow from the store.
PATCH/api/v1/status/workflow/{name}
Patches the specified workflow status from the store.

status

GET/api/v1/status/workflow
Returns the specified workflowStatus object from the store.
POST/api/v1/status/workflow
Creates a new workflow status in the store.
GET/api/v1/status/workflow/{name}
Returns the specified workflow object from the store with the name in params.
DELETE/api/v1/status/workflow/{name}
Deletes the specified workflow from the store.

webhook

GET/api/v1/webhook/trigger/{workflow}/{trigger}/{pipeline}
Webhook endpoints to trigger the pipelines of a particular workflow.

health

GET/health
Health route for Xene API server.

auth

GET/oauth/refresh/
Handle authentication token refresh for the oauth provider.
GET/oauth/{provider}
Handles login for xene
GET/oauth/{provider}/redirect
Handles redirect from the login oauth provider.

Models

#/definitions/response.AgentInforesponse.AgentInfo{...}
#/definitions/response.AgentSecretInforesponse.AgentSecretInfo{...}
#/definitions/response.AgentTriggerInforesponse.AgentTriggerInfo{...}
#/definitions/response.AgentVerboseInforesponse.AgentVerboseInfo{...}
#/definitions/response.AgentWorkflowInforesponse.AgentWorkflowInfo{...}
#/definitions/response.HTTPErrorresponse.HTTPError{...}
#/definitions/response.HTTPMessageresponse.HTTPMessage{...}
#/definitions/response.JWTAuthresponse.JWTAuth{...}
#/definitions/response.KVPairresponse.KVPair{...}
#/definitions/response.OauthLoginresponse.OauthLogin{...}
#/definitions/response.PipelineInforesponse.PipelineInfo{...}
#/definitions/response.PipelineRunInforesponse.PipelineRunInfo{...}
#/definitions/response.PipelineRunVerboseInforesponse.PipelineRunVerboseInfo{...}
#/definitions/response.RegistryItemresponse.RegistryItem{...}
response.RegistryItemsFromPrefix{...}
#/definitions/response.SecretInforesponse.SecretInfo{...}
#/definitions/response.WorkflowInforesponse.WorkflowInfo{...}