Skip to content

Direktiv API

Direktiv Open API Specification Direktiv Documentation can be found at https://docs.direktiv.io/

Informations

Version

1.0.0

Contact

info@direktiv.io

Content negotiation

URI Schemes

  • http
  • https

Consumes

  • application/json
  • text/plain

Produces

  • application/json
  • text/event-stream

Access control

Security Schemes

api_key (header: KEY)

Type: apikey

Security Requirements

  • api_key

All endpoints

directory

Method URI Name Summary
PUT /api/namespaces/{namespace}/tree/{directory}?op=create-directory create directory Create a Directory

global_services

Method URI Name Summary
POST /api/functions create global service Create Global Service
DELETE /api/functions/{serviceName}/revisions/{revisionGeneration} delete global revision Delete Global Service Revision
DELETE /api/functions/{serviceName} delete global service Delete Global Service
GET /api/functions/{serviceName} get global service Get Global Service Details
GET /api/functions get global service list Get Global Services List
GET /api/functions/{serviceName}/revisions/{revisionGeneration}/pods list global service revision pods Get Global Service Revision Pods List
POST /api/functions/{serviceName} update global service Create Global Service Revision
PATCH /api/functions/{serviceName} update global service traffic Update Global Service Traffic
GET /api/functions/{serviceName}/revisions/{revisionGeneration} watch global service revision Watch Global Service Revision
GET /api/functions/{serviceName}/revisions watch global service revision list Watch Global Service Revision List

instances

Method URI Name Summary
POST /api/namespaces/{namespace}/instances/{instance}/cancel cancel instance Cancel a Pending Instance
GET /api/namespaces/{namespace}/instances/{instance} get instance Get a Instance
GET /api/namespaces/{namespace}/instances/{instance}/input get instance input Get a Instance Input
GET /api/namespaces/{namespace}/instances get instance list Get List Instances
GET /api/namespaces/{namespace}/instances/{instance}/output get instance output Get a Instance Output

logs

Method URI Name Summary
GET /api/namespaces/{namespace}/tree/{workflow}?op=logs get workflow logs Get Workflow Level Logs
GET /api/namespaces/{namespace}/instances/{instance}/logs instance logs Gets Instance Logs
GET /api/namespaces/{namespace}/logs namespace logs Gets Namespace Level Logs
GET /api/logs server logs Get Direktiv Server Logs

metrics

Method URI Name Summary
GET /api/namespaces/{namespace}/metrics/failed namespace metrics failed Gets Namespace Failed Workflow Instances Metrics
GET /api/namespaces/{namespace}/metrics/invoked namespace metrics invoked Gets Namespace Invoked Workflow Metrics
GET /api/namespaces/{namespace}/metrics/milliseconds namespace metrics milliseconds Gets Namespace Workflow Timing Metrics
GET /api/namespaces/{namespace}/metrics/successful namespace metrics successful Gets Namespace Successful Workflow Instances Metrics
GET /api/namespaces/{namespace}/tree/{workflow}?op=metrics-invoked workflow metrics invoked Gets Invoked Workflow Metrics
GET /api/namespaces/{namespace}/tree/{workflow}?op=metrics-failed workflow metrics milliseconds Gets Workflow Time Metrics
GET /api/namespaces/{namespace}/tree/{workflow}?op=metrics-state-milliseconds workflow metrics state milliseconds Gets a Workflow State Time Metrics
GET /api/namespaces/{namespace}/tree/{workflow}?op=metrics-successful workflow metrics successful Gets Successful Workflow Metrics

namespace_services

Method URI Name Summary
POST /api/functions/namespaces/{namespace} create namespace service Create Namespace Service
DELETE /api/functions/namespaces/{namespace}/function/{serviceName}/revisions/{revisionGeneration} delete namespace revision Delete Namespace Service Revision
DELETE /api/functions/namespaces/{namespace}/function/{serviceName} delete namespace service Delete Namespace Service
GET /api/functions/namespaces/{namespace}/function/{serviceName} get namespace service Get Namespace Service Details
GET /api/functions/namespaces/{namespace} get namespace service list Get Namespace Services List
GET /api/functions/namespaces/{namespace}/function/{serviceName}/revisions/{revisionGeneration}/pods list namespace service revision pods Get Namespace Service Revision Pods List
POST /api/functions/namespaces/{namespace}/function/{serviceName} update namespace service Create Namespace Service Revision
PATCH /api/functions/namespaces/{namespace}/function/{serviceName} update namespace service traffic Update Namespace Service Traffic
GET /api/functions/namespaces/{namespace}/function/{serviceName}/revisions/{revisionGeneration} watch namespace service revision Watch Namespace Service Revision
GET /api/functions/namespaces/{namespace}/function/{serviceName}/revisions watch namespace service revision list Watch Namespace Service Revision List

namespaces

Method URI Name Summary
PUT /api/namespaces/{namespace} create namespace Creates a namespace
DELETE /api/namespaces/{namespace} delete namespace Delete a namespace
GET /api/namespaces/{namespace}/config get namespace config Gets a namespace config
GET /api/namespaces get namespaces Gets the list of namespaces
PATCH /api/namespaces/{namespace}/config set namespace config Sets a namespace config

node

Method URI Name Summary
DELETE /api/namespaces/{namespace}/tree/{node}?op=delete-node delete node Delete a node
GET /api/namespaces/{namespace}/tree/{nodePath} get nodes Get List of Namespace Nodes

other

Method URI Name Summary
POST /api/namespaces/{namespace}/broadcast broadcast cloudevent Broadcast Cloud Event
POST /api/jq jq playground JQ Playground api to test jq queries
GET /api/version version Returns version information for servers in the cluster.

registries

Method URI Name Summary
POST /api/functions/registries/private create global private registry Create a Global Container Registry
POST /api/functions/registries/global create global registry Create a Global Container Registry
POST /api/functions/registries/namespaces/{namespace} create registry Create a Namespace Container Registry
DELETE /api/functions/registries/private delete global private registry Delete a Global Container Registry
DELETE /api/functions/registries/global delete global registry Delete a global Container Registry
DELETE /api/functions/registries/namespaces/{namespace} delete registry Delete a Namespace Container Registry
GET /api/functions/registries/private get global private registries Get List of Global Private Registries
GET /api/functions/registries/global get global registries Get List of Global Registries
GET /api/functions/registries/namespaces/{namespace} get registries Get List of Namespace Registries

secrets

Method URI Name Summary
PUT /api/namespaces/{namespace}/secrets/{secret} create secret Create a Namespace Secret
DELETE /api/namespaces/{namespace}/secrets/{secret} delete secret Delete a Namespace Secret
GET /api/namespaces/{namespace}/secrets get secrets Get List of Namespace Secrets

variables

Method URI Name Summary
DELETE /api/namespaces/{namespace}/instances/{instance}/vars/{variable} delete instance variable Delete a Instance Variable
DELETE /api/namespaces/{namespace}/vars/{variable} delete namespace variable Delete a Namespace Variable
DELETE /api/namespaces/{namespace}/tree/{workflow}?op=delete-var delete workflow variable Delete a Workflow Variable
GET /api/namespaces/{namespace}/instances/{instance}/vars/{variable} get instance variable Get a Instance Variable
GET /api/namespaces/{namespace}/instances/{instance}/vars get instance variables Get List of Instance Variable
GET /api/namespaces/{namespace}/vars/{variable} get namespace variable Get a Namespace Variable
GET /api/namespaces/{namespace}/vars get namespace variables Get Namespace Variable List
GET /api/namespaces/{namespace}/tree/{workflow}?op=var get workflow variable Get a Workflow Variable
GET /api/namespaces/{namespace}/tree/{workflow}?op=vars get workflow variables Get List of Workflow Variables
PUT /api/namespaces/{namespace}/instances/{instance}/vars/{variable} set instance variable Set a Instance Variable
PUT /api/namespaces/{namespace}/vars/{variable} set namespace variable Set a Namespace Variable
PUT /api/namespaces/{namespace}/tree/{workflow}?op=set-var set workflow variable Set a Workflow Variable

workflow_services

Method URI Name Summary
GET /api/functions/namespaces/{namespace}/tree/{workflow}?op=function get workflow service Get Workflow Service Details
GET /api/functions/namespaces/{namespace}/tree/{workflow}?op=function-revision get workflow service revision Get Workflow Service Revision
GET /api/functions/namespaces/{namespace}/tree/{workflow}?op=function-revisions get workflow service revision list Get Workflow Service Revision List
GET /api/functions/namespaces/{namespace}/tree/{workflow}?op=pods list workflow service revision pods Get Workflow Service Revision Pods List
GET /api/functions/namespaces/{namespace}/tree/{workflow}?op=services list workflow services Get Workflow Services List

workflows

Method URI Name Summary
GET /api/namespaces/{namespace}/tree/{workflow}?op=wait await execute workflow Await Execute a Workflow
POST /api/namespaces/{namespace}/tree/{workflow}?op=wait await execute workflow body Await Execute a Workflow With Body
PUT /api/namespaces/{namespace}/tree/{workflow}?op=create-workflow create workflow Create a Workflow
POST /api/namespaces/{namespace}/tree/{workflow}?op=execute execute workflow Execute a Workflow
POST /api/namespaces/{namespace}/tree/{workflow}?op=set-workflow-event-logging set workflow cloud event logs Set Cloud Event for Workflow to Log to
POST /api/namespaces/{namespace}/tree/{workflow}?op=toggle toggle workflow Set Cloud Event for Workflow to Log to
POST /api/namespaces/{namespace}/tree/{workflow}?op=update-workflow update workflow Update a Workflow

Paths

Await Execute a Workflow (awaitExecuteWorkflow)

GET /api/namespaces/{namespace}/tree/{workflow}?op=wait

Executes a workflow. This path will wait until the workflow execution has completed and return the instance output. NOTE: Input can also be provided with the input.X query parameters; Where X is the json key. Only top level json keys are supported when providing input with query parameters.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
ctype query string string Manually set the Content-Type response header instead of auto-detected. This doesn't change the body of the response in any way.
field query string string If provided, instead of returning the entire output json the response body will contain the single top-level json field
raw-output query boolean bool If set to true, will return an empty output as null, encoded base64 data as decoded binary data, and quoted json strings as a escaped string.

All responses

Code Status Description Has headers Schema
200 OK successfully executed workflow schema

Responses

200 - successfully executed workflow

Status: OK

Schema

Await Execute a Workflow With Body (awaitExecuteWorkflowBody)

POST /api/namespaces/{namespace}/tree/{workflow}?op=wait

Executes a workflow with optionally some input provided in the request body as json. This path will wait until the workflow execution has completed and return the instance output. NOTE: Input can also be provided with the input.X query parameters; Where X is the json key. Only top level json keys are supported when providing input with query parameters. Input query parameters are only read if the request has no body.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
ctype query string string Manually set the Content-Type response header instead of auto-detected. This doesn't change the body of the response in any way.
field query string string If provided, instead of returning the entire output json the response body will contain the single top-level json field
raw-output query boolean bool If set to true, will return an empty output as null, encoded base64 data as decoded binary data, and quoted json strings as a escaped string.
Workflow Input body interface{} interface{} The input of this workflow instance

All responses

Code Status Description Has headers Schema
200 OK successfully executed workflow schema

Responses

200 - successfully executed workflow

Status: OK

Schema

Broadcast Cloud Event (broadcastCloudevent)

POST /api/namespaces/{namespace}/broadcast

Broadcast a cloud event to a namespace. Cloud events posted to this api will be picked up by any workflows listening to the same event type on the namescape. The body of this request should follow the cloud event core specification defined at https://github.com/cloudevents/spec .

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
cloudevent body interface{} interface{} Cloud Event request to be sent.

All responses

Code Status Description Has headers Schema
200 OK successfully sent cloud event schema

Responses

200 - successfully sent cloud event

Status: OK

Schema

Cancel a Pending Instance (cancelInstance)

POST /api/namespaces/{namespace}/instances/{instance}/cancel

Cancel a currently pending instance.

Parameters

Name Source Type Go type Separator Required Default Description
instance path string string target instance
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully cancelled instance schema

Responses

200 - successfully cancelled instance

Status: OK

Schema

Create a Directory (createDirectory)

PUT /api/namespaces/{namespace}/tree/{directory}?op=create-directory

Creates a directory at the target path.

Parameters

Name Source Type Go type Separator Required Default Description
directory path string string path to target directory
namespace path string string target namespace
op query string string "create-directory" the operation for the api

All responses

Code Status Description Has headers Schema
200 OK directory has been created schema
default an error has occurred schema

Responses

200 - directory has been created

Status: OK

Schema

OkBody

Default Response

an error has occurred

Schema

ErrorResponse

Create a Global Container Registry (createGlobalPrivateRegistry)

POST /api/functions/registries/private

Create a global container registry. Global Private registries are only available to global services. This can be used to connect your workflows to private container registries that require tokens. The data property in the body is made up from the registry user and token. It follows the pattern : data=USER:TOKEN

Parameters

Name Source Type Go type Separator Required Default Description
Registry Payload body CreateGlobalPrivateRegistryBody CreateGlobalPrivateRegistryBody Payload that contains registry data

All responses

Code Status Description Has headers Schema
200 OK successfully created global private registry schema

Responses

200 - successfully created global private registry

Status: OK

Schema
Inlined models

CreateGlobalPrivateRegistryBody

Properties

Name Type Go type Required Default Description Example
data string string Target registry connection data containing the user and token.
reg string string Target registry URL

Create a Global Container Registry (createGlobalRegistry)

POST /api/functions/registries/global

Create a global container registry. Global registries are available to all services. This can be used to connect your workflows to private container registries that require tokens. The data property in the body is made up from the registry user and token. It follows the pattern : data=USER:TOKEN

Parameters

Name Source Type Go type Separator Required Default Description
Registry Payload body CreateGlobalRegistryBody CreateGlobalRegistryBody Payload that contains registry data

All responses

Code Status Description Has headers Schema
200 OK successfully created global registry schema

Responses

200 - successfully created global registry

Status: OK

Schema
Inlined models

CreateGlobalRegistryBody

Properties

Name Type Go type Required Default Description Example
data string string Target registry connection data containing the user and token.
reg string string Target registry URL

Create Global Service (createGlobalService)

POST /api/functions

Creates global scoped knative service. Service Names are unique on a scope level. These services can be used as functions in workflows, more about this can be read here: https://docs.direktiv.io/docs/walkthrough/using-functions.html

Parameters

Name Source Type Go type Separator Required Default Description
Service body CreateGlobalServiceBody CreateGlobalServiceBody Payload that contains information on new service

All responses

Code Status Description Has headers Schema
200 OK successfully created service schema

Responses

200 - successfully created service

Status: OK

Schema
Inlined models

CreateGlobalServiceBody

Properties

Name Type Go type Required Default Description Example
cmd string string
image string string Target image a service will use
minScale integer int64 Minimum amount of service pods to be live
name string string Name of new service
size string string Size of created service pods

Creates a namespace (createNamespace)

PUT /api/namespaces/{namespace}

Creates a new namespace.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace to create

All responses

Code Status Description Has headers Schema
200 OK namespace has been successfully created schema
default an error has occurred schema

Responses

200 - namespace has been successfully created

Status: OK

Schema

OkBody

Default Response

an error has occurred

Schema

ErrorResponse

Create Namespace Service (createNamespaceService)

POST /api/functions/namespaces/{namespace}

Creates namespace scoped knative service. Service Names are unique on a scope level. These services can be used as functions in workflows, more about this can be read here: https://docs.direktiv.io/docs/walkthrough/using-functions.html

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
Service body CreateNamespaceServiceBody CreateNamespaceServiceBody Payload that contains information on new service

All responses

Code Status Description Has headers Schema
200 OK successfully created service schema

Responses

200 - successfully created service

Status: OK

Schema
Inlined models

CreateNamespaceServiceBody

Properties

Name Type Go type Required Default Description Example
cmd string string
image string string Target image a service will use
minScale integer int64 Minimum amount of service pods to be live
name string string Name of new service
size string string Size of created service pods

Create a Namespace Container Registry (createRegistry)

POST /api/functions/registries/namespaces/{namespace}

Create a namespace container registry. This can be used to connect your workflows to private container registries that require tokens. The data property in the body is made up from the registry user and token. It follows the pattern : data=USER:TOKEN

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
Registry Payload body CreateRegistryBody CreateRegistryBody Payload that contains registry data

All responses

Code Status Description Has headers Schema
200 OK successfully created namespace registry schema

Responses

200 - successfully created namespace registry

Status: OK

Schema
Inlined models

CreateRegistryBody

Properties

Name Type Go type Required Default Description Example
data string string Target registry connection data containing the user and token.
reg string string Target registry URL

Create a Namespace Secret (createSecret)

PUT /api/namespaces/{namespace}/secrets/{secret}

Create a namespace secret.

Consumes

  • text/plain

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
secret path string string target secret
Secret Payload body string string Payload that contains secret data.

All responses

Code Status Description Has headers Schema
200 OK namespace has been successfully created schema
default an error has occurred schema

Responses

200 - namespace has been successfully created

Status: OK

Schema

OkBody

Default Response

an error has occurred

Schema

ErrorResponse

Create a Workflow (createWorkflow)

PUT /api/namespaces/{namespace}/tree/{workflow}?op=create-workflow

Creates a workflow at the target path. The body of this request should contain the workflow yaml.

Consumes

  • text/plain

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
op query string string "create-workflow" the operation for the api
workflow data body string string Payload that contains the direktiv workflow yaml to create.

All responses

Code Status Description Has headers Schema
200 OK successfully created workflow schema
default an error has occurred schema

Responses

200 - successfully created workflow

Status: OK

Schema

OkBody

Default Response

an error has occurred

Schema

ErrorResponse

Delete a Global Container Registry (deleteGlobalPrivateRegistry)

DELETE /api/functions/registries/private

Delete a global container registry. Global Private registries are only available to global services.

Parameters

Name Source Type Go type Separator Required Default Description
Registry Payload body DeleteGlobalPrivateRegistryBody DeleteGlobalPrivateRegistryBody Payload that contains registry data

All responses

Code Status Description Has headers Schema
200 OK successfully delete global private registry schema

Responses

200 - successfully delete global private registry

Status: OK

Schema
Inlined models

DeleteGlobalPrivateRegistryBody

Properties

Name Type Go type Required Default Description Example
reg string string Target registry URL

Delete a global Container Registry (deleteGlobalRegistry)

DELETE /api/functions/registries/global

Delete a Global container registry Global registries are available to all services.

Parameters

Name Source Type Go type Separator Required Default Description
Registry Payload body DeleteGlobalRegistryBody DeleteGlobalRegistryBody Payload that contains registry data

All responses

Code Status Description Has headers Schema
200 OK successfully delete global registry schema

Responses

200 - successfully delete global registry

Status: OK

Schema
Inlined models

DeleteGlobalRegistryBody

Properties

Name Type Go type Required Default Description Example
reg string string Target registry URL

Delete Global Service Revision (deleteGlobalRevision)

DELETE /api/functions/{serviceName}/revisions/{revisionGeneration}

Delete a global scoped knative service revision. The target revision generation is the number suffix on a revision. Example: A revision named 'global-fast-request-00003' would have the revisionGeneration '00003'. Note: Revisions with traffic cannot be deleted.

Parameters

Name Source Type Go type Separator Required Default Description
revisionGeneration path string string target revision generation
serviceName path string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully deleted service revision schema

Responses

200 - successfully deleted service revision

Status: OK

Schema

Delete Global Service (deleteGlobalService)

DELETE /api/functions/{serviceName}

Deletes global scoped knative service and all its revisions.

Parameters

Name Source Type Go type Separator Required Default Description
serviceName path string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully deleted service schema

Responses

200 - successfully deleted service

Status: OK

Schema

Delete a Instance Variable (deleteInstanceVariable)

DELETE /api/namespaces/{namespace}/instances/{instance}/vars/{variable}

Delete a instance variable.

Parameters

Name Source Type Go type Separator Required Default Description
instance path string string target instance
namespace path string string target namespace
variable path string string target variable

All responses

Code Status Description Has headers Schema
200 OK successfully deleted instance variable schema

Responses

200 - successfully deleted instance variable

Status: OK

Schema

Delete a namespace (deleteNamespace)

DELETE /api/namespaces/{namespace}

Delete a namespace. A namespace will not delete by default if it has any child resources (workflows, etc...). Deleting the namespace with all its children can be done using the recursive query parameter.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace to delete
recursive query boolean bool recursively deletes all child resources

All responses

Code Status Description Has headers Schema
200 OK namespace has been successfully deleted schema
default an error has occurred schema

Responses

200 - namespace has been successfully deleted

Status: OK

Schema

OkBody

Default Response

an error has occurred

Schema

ErrorResponse

Delete Namespace Service Revision (deleteNamespaceRevision)

DELETE /api/functions/namespaces/{namespace}/function/{serviceName}/revisions/{revisionGeneration}

Delete a namespace scoped knative service revision. The target revision generation is the number suffix on a revision. Example: A revision named 'namespace-direktiv-fast-request-00003' would have the revisionGeneration '00003'. Note: Revisions with traffic cannot be deleted.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
revisionGeneration path string string target revision generation
serviceName path string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully deleted service revision schema

Responses

200 - successfully deleted service revision

Status: OK

Schema

Delete Namespace Service (deleteNamespaceService)

DELETE /api/functions/namespaces/{namespace}/function/{serviceName}

Deletes namespace scoped knative service and all its revisions.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
serviceName path string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully deleted service schema

Responses

200 - successfully deleted service

Status: OK

Schema

Delete a Namespace Variable (deleteNamespaceVariable)

DELETE /api/namespaces/{namespace}/vars/{variable}

Delete a namespace variable.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
variable path string string target variable

All responses

Code Status Description Has headers Schema
200 OK successfully deleted namespace variable schema

Responses

200 - successfully deleted namespace variable

Status: OK

Schema

Delete a node (deleteNode)

DELETE /api/namespaces/{namespace}/tree/{node}?op=delete-node

Creates a directory at the target path.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
node path string string path to target node
op query string string "delete-node" the operation for the api

All responses

Code Status Description Has headers Schema
200 OK node has been deleted schema
default an error has occurred schema

Responses

200 - node has been deleted

Status: OK

Schema

OkBody

Default Response

an error has occurred

Schema

ErrorResponse

Delete a Namespace Container Registry (deleteRegistry)

DELETE /api/functions/registries/namespaces/{namespace}

Delete a namespace container registry

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
Registry Payload body DeleteRegistryBody DeleteRegistryBody Payload that contains registry data

All responses

Code Status Description Has headers Schema
200 OK successfully delete namespace registry schema

Responses

200 - successfully delete namespace registry

Status: OK

Schema
Inlined models

DeleteRegistryBody

Properties

Name Type Go type Required Default Description Example
reg string string Target registry URL

Delete a Namespace Secret (deleteSecret)

DELETE /api/namespaces/{namespace}/secrets/{secret}

Delete a namespace secret.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
secret path string string target secret

All responses

Code Status Description Has headers Schema
200 OK namespace has been successfully created schema
default an error has occurred schema

Responses

200 - namespace has been successfully created

Status: OK

Schema

OkBody

Default Response

an error has occurred

Schema

ErrorResponse

Delete a Workflow Variable (deleteWorkflowVariable)

DELETE /api/namespaces/{namespace}/tree/{workflow}?op=delete-var

Delete a workflow variable.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
var query string string target variable

All responses

Code Status Description Has headers Schema
200 OK successfully deleted workflow variable schema

Responses

200 - successfully deleted workflow variable

Status: OK

Schema

Execute a Workflow (executeWorkflow)

POST /api/namespaces/{namespace}/tree/{workflow}?op=execute

Executes a workflow with optionally some input provided in the request body as json.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
op query string string "execute" the operation for the api
Workflow Input body interface{} interface{} The input of this workflow instance

All responses

Code Status Description Has headers Schema
200 OK node has been deleted schema
default an error has occurred schema

Responses

200 - node has been deleted

Status: OK

Schema

OkBody

Default Response

an error has occurred

Schema

ErrorResponse

Get List of Global Private Registries (getGlobalPrivateRegistries)

GET /api/functions/registries/private

Gets the list of global private registries. Global Private registries are only available to global services.

All responses

Code Status Description Has headers Schema
200 OK successfully got global private registries schema

Responses

200 - successfully got global private registries

Status: OK

Schema

Get List of Global Registries (getGlobalRegistries)

GET /api/functions/registries/global

Gets the list of global registries. Global registries are available to all services.

All responses

Code Status Description Has headers Schema
200 OK successfully got global registries schema

Responses

200 - successfully got global registries

Status: OK

Schema

Get Global Service Details (getGlobalService)

GET /api/functions/{serviceName}

Get details of a global scoped knative service.

Parameters

Name Source Type Go type Separator Required Default Description
serviceName path string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully got service details schema

Responses

200 - successfully got service details

Status: OK

Schema

Get Global Services List (getGlobalServiceList)

GET /api/functions

Gets a list of global knative services.

All responses

Code Status Description Has headers Schema
200 OK successfully got services list schema

Responses

200 - successfully got services list

Status: OK

Schema

Get a Instance (getInstance)

GET /api/namespaces/{namespace}/instances/{instance}

Gets the details of a executed workflow instance in this namespace.

Parameters

Name Source Type Go type Separator Required Default Description
instance path string string target instance
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got instance schema
default an error has occurred schema

Responses

200 - successfully got instance

Status: OK

Schema

OkBody

Default Response

an error has occurred

Schema

ErrorResponse

Get a Instance Input (getInstanceInput)

GET /api/namespaces/{namespace}/instances/{instance}/input

Gets the input an instance was provided when executed.

Parameters

Name Source Type Go type Separator Required Default Description
instance path string string target instance
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got instance input schema

Responses

200 - successfully got instance input

Status: OK

Schema

Get List Instances (getInstanceList)

GET /api/namespaces/{namespace}/instances

Gets a list of instances in a namespace.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got namespace instances schema

Responses

200 - successfully got namespace instances

Status: OK

Schema

Get a Instance Output (getInstanceOutput)

GET /api/namespaces/{namespace}/instances/{instance}/output

Gets the output an instance was provided when executed.

Parameters

Name Source Type Go type Separator Required Default Description
instance path string string target instance
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got instance output schema

Responses

200 - successfully got instance output

Status: OK

Schema

Get a Instance Variable (getInstanceVariable)

GET /api/namespaces/{namespace}/instances/{instance}/vars/{variable}

Get the value sorted in a instance variable.

Parameters

Name Source Type Go type Separator Required Default Description
instance path string string target instance
namespace path string string target namespace
variable path string string target variable

All responses

Code Status Description Has headers Schema
200 OK successfully got instance variable schema

Responses

200 - successfully got instance variable

Status: OK

Schema

Get List of Instance Variable (getInstanceVariables)

GET /api/namespaces/{namespace}/instances/{instance}/vars

Gets a list of variables in a instance.

Parameters

Name Source Type Go type Separator Required Default Description
instance path string string target instance
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got instance variables schema

Responses

200 - successfully got instance variables

Status: OK

Schema

Gets a namespace config (getNamespaceConfig)

GET /api/namespaces/{namespace}/config

Gets a namespace config.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace to update

All responses

Code Status Description Has headers Schema
200 OK successfully got namespace config schema

Responses

200 - successfully got namespace config

Status: OK

Schema

Get Namespace Service Details (getNamespaceService)

GET /api/functions/namespaces/{namespace}/function/{serviceName}

Get details of a namespace scoped knative service.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
serviceName path string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully got service details schema

Responses

200 - successfully got service details

Status: OK

Schema

Get Namespace Services List (getNamespaceServiceList)

GET /api/functions/namespaces/{namespace}

Gets a list of namespace knative services.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got services list schema

Responses

200 - successfully got services list

Status: OK

Schema

Get a Namespace Variable (getNamespaceVariable)

GET /api/namespaces/{namespace}/vars/{variable}

Get the value sorted in a namespace variable.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
variable path string string target variable

All responses

Code Status Description Has headers Schema
200 OK successfully got namespace variable schema

Responses

200 - successfully got namespace variable

Status: OK

Schema

Get Namespace Variable List (getNamespaceVariables)

GET /api/namespaces/{namespace}/vars

Gets a list of variables in a namespace.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got namespace variables schema

Responses

200 - successfully got namespace variables

Status: OK

Schema

Gets the list of namespaces (getNamespaces)

GET /api/namespaces

Gets the list of namespaces.

All responses

Code Status Description Has headers Schema
200 OK successfully got list of namespaces schema

Responses

200 - successfully got list of namespaces

Status: OK

Schema

Get List of Namespace Nodes (getNodes)

GET /api/namespaces/{namespace}/tree/{nodePath}

Gets Workflow and Directory Nodes at nodePath.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
nodePath path string string target path in tree

All responses

Code Status Description Has headers Schema
200 OK successfully got namespace nodes schema
default an error has occurred schema

Responses

200 - successfully got namespace nodes

Status: OK

Schema

OkBody

Default Response

an error has occurred

Schema

ErrorResponse

Get List of Namespace Registries (getRegistries)

GET /api/functions/registries/namespaces/{namespace}

Gets the list of namespace registries.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got namespace registries schema

Responses

200 - successfully got namespace registries

Status: OK

Schema

Get List of Namespace Secrets (getSecrets)

GET /api/namespaces/{namespace}/secrets

Gets the list of namespace secrets.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got namespace nodes schema
default an error has occurred schema

Responses

200 - successfully got namespace nodes

Status: OK

Schema

OkBody

Default Response

an error has occurred

Schema

ErrorResponse

Get Workflow Level Logs (getWorkflowLogs)

GET /api/namespaces/{namespace}/tree/{workflow}?op=logs

Get workflow level logs.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow

All responses

Code Status Description Has headers Schema
200 OK successfully got workflow logs schema

Responses

200 - successfully got workflow logs

Status: OK

Schema

Get Workflow Service Details (getWorkflowService)

GET /api/functions/namespaces/{namespace}/tree/{workflow}?op=function

Get a workflow scoped knative service details. Note: This is a Server-Sent-Event endpoint, and will not work with the default swagger client.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
svn query string string target service name
version query string string target service version

All responses

Code Status Description Has headers Schema
200 OK successfully got service details schema

Responses

200 - successfully got service details

Status: OK

Schema

Get Workflow Service Revision (getWorkflowServiceRevision)

GET /api/functions/namespaces/{namespace}/tree/{workflow}?op=function-revision

Get a workflow scoped knative service revision. This will return details on a single revision. The target revision generation (rev query) is the number suffix on a revision. Example: A revision named 'workflow-10640097968065193909-get-00001' would have the revisionGeneration '00001'.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
rev query string string target service revison
svn query string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully got service revision details schema

Responses

200 - successfully got service revision details

Status: OK

Schema

Get Workflow Service Revision List (getWorkflowServiceRevisionList)

GET /api/functions/namespaces/{namespace}/tree/{workflow}?op=function-revisions

Get the revision list of a workflow scoped knative service.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
svn query string string target service name
version query string string target service version

All responses

Code Status Description Has headers Schema
200 OK successfully got service revisions schema

Responses

200 - successfully got service revisions

Status: OK

Schema

Get a Workflow Variable (getWorkflowVariable)

GET /api/namespaces/{namespace}/tree/{workflow}?op=var

Get the value sorted in a workflow variable.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
var query string string target variable

All responses

Code Status Description Has headers Schema
200 OK successfully got workflow variable schema

Responses

200 - successfully got workflow variable

Status: OK

Schema

Get List of Workflow Variables (getWorkflowVariables)

GET /api/namespaces/{namespace}/tree/{workflow}?op=vars

Gets a list of variables in a workflow.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow

All responses

Code Status Description Has headers Schema
200 OK successfully got workflow variables schema

Responses

200 - successfully got workflow variables

Status: OK

Schema

Gets Instance Logs (instanceLogs)

GET /api/namespaces/{namespace}/instances/{instance}/logs

Gets the logs of an executed instance.

Parameters

Name Source Type Go type Separator Required Default Description
instance path string string target instance id
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got instance logs schema
default an error has occurred schema

Responses

200 - successfully got instance logs

Status: OK

Schema

OkBody

Default Response

an error has occurred

Schema

ErrorResponse

JQ Playground api to test jq queries (jqPlayground)

POST /api/jq

JQ Playground is a sandbox where you can test jq queries with custom data.

Parameters

Name Source Type Go type Separator Required Default Description
JQ payload body JqPlaygroundBody JqPlaygroundBody Payload that contains both the JSON data to manipulate and jq query.

All responses

Code Status Description Has headers Schema
200 OK jq query was successful schema
400 Bad Request the request was invalid schema
500 Internal Server Error an unexpected internal error occurred schema

Responses

200 - jq query was successful

Status: OK

Schema
400 - the request was invalid

Status: Bad Request

Schema
500 - an unexpected internal error occurred

Status: Internal Server Error

Schema
Inlined models

JqPlaygroundBody

Properties

Name Type Go type Required Default Description Example
data string string JSON data encoded in base64
query string string jq query to manipulate JSON data

Get Global Service Revision Pods List (listGlobalServiceRevisionPods)

GET /api/functions/{serviceName}/revisions/{revisionGeneration}/pods

List a revisions pods of a global scoped knative service. The target revision generation is the number suffix on a revision. Example: A revision named 'global-fast-request-00003' would have the revisionGeneration '00003' .

Parameters

Name Source Type Go type Separator Required Default Description
revisionGeneration path string string target revision generation
serviceName path string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully got list of a service revision pods schema

Responses

200 - successfully got list of a service revision pods

Status: OK

Schema

Get Namespace Service Revision Pods List (listNamespaceServiceRevisionPods)

GET /api/functions/namespaces/{namespace}/function/{serviceName}/revisions/{revisionGeneration}/pods

List a revisions pods of a namespace scoped knative service. The target revision generation is the number suffix on a revision. Example: A revision named 'namespace-direktiv-fast-request-00003' would have the revisionGeneration '00003'.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
revisionGeneration path string string target revision generation
serviceName path string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully got list of a service revision pods schema

Responses

200 - successfully got list of a service revision pods

Status: OK

Schema

Get Workflow Service Revision Pods List (listWorkflowServiceRevisionPods)

GET /api/functions/namespaces/{namespace}/tree/{workflow}?op=pods

List a revisions pods of a workflow scoped knative service. The target revision generation (rev query) is the number suffix on a revision. Example: A revision named 'workflow-10640097968065193909-get-00001' would have the revisionGeneration '00001'.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
rev query string string target service revison
svn query string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully got list of a service revision pods schema

Responses

200 - successfully got list of a service revision pods

Status: OK

Schema

Get Workflow Services List (listWorkflowServices)

GET /api/functions/namespaces/{namespace}/tree/{workflow}?op=services

Gets a list of workflow knative services.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow

All responses

Code Status Description Has headers Schema
200 OK successfully got services list schema

Responses

200 - successfully got services list

Status: OK

Schema

Gets Namespace Level Logs (namespaceLogs)

GET /api/namespaces/{namespace}/logs

Gets Namespace Level Logs.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got namespace logs schema

Responses

200 - successfully got namespace logs

Status: OK

Schema

Gets Namespace Failed Workflow Instances Metrics (namespaceMetricsFailed)

GET /api/namespaces/{namespace}/metrics/failed

Get metrics of failed workflows in the targeted namespace.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got namespace metrics schema

Responses

200 - successfully got namespace metrics

Status: OK

Schema

Gets Namespace Invoked Workflow Metrics (namespaceMetricsInvoked)

GET /api/namespaces/{namespace}/metrics/invoked

Get metrics of invoked workflows in the targeted namespace.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got namespace metrics schema

Responses

200 - successfully got namespace metrics

Status: OK

Schema

Gets Namespace Workflow Timing Metrics (namespaceMetricsMilliseconds)

GET /api/namespaces/{namespace}/metrics/milliseconds

Get timing metrics of workflows in the targeted namespace.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got namespace metrics schema

Responses

200 - successfully got namespace metrics

Status: OK

Schema

Gets Namespace Successful Workflow Instances Metrics (namespaceMetricsSuccessful)

GET /api/namespaces/{namespace}/metrics/successful

Get metrics of successful workflows in the targeted namespace.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace

All responses

Code Status Description Has headers Schema
200 OK successfully got namespace metrics schema

Responses

200 - successfully got namespace metrics

Status: OK

Schema

Get Direktiv Server Logs (serverLogs)

GET /api/logs

Gets Direktiv Server Logs.

All responses

Code Status Description Has headers Schema
200 OK successfully got server logs schema
default an error has occurred schema

Responses

200 - successfully got server logs

Status: OK

Schema

OkBody

Default Response

an error has occurred

Schema

ErrorResponse

Set a Instance Variable (setInstanceVariable)

PUT /api/namespaces/{namespace}/instances/{instance}/vars/{variable}

Set the value sorted in a instance variable. If the target variable does not exists, it will be created. Variable data can be anything.

Consumes

  • text/plain

Parameters

Name Source Type Go type Separator Required Default Description
instance path string string target instance
namespace path string string target namespace
variable path string string target variable
data body string string Payload that contains variable data.

All responses

Code Status Description Has headers Schema
200 OK successfully set instance variable schema

Responses

200 - successfully set instance variable

Status: OK

Schema

Sets a namespace config (setNamespaceConfig)

PATCH /api/namespaces/{namespace}/config

Sets a namespace config.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace to update
Config Payload body SetNamespaceConfigBody SetNamespaceConfigBody Payload that contains the config information to set. Note: This payload only need to contain the properities you wish to set.

All responses

Code Status Description Has headers Schema
200 OK namespace config has been successfully been updated schema

Responses

200 - namespace config has been successfully been updated

Status: OK

Schema
Inlined models

SetNamespaceConfigBody

Properties

Name Type Go type Required Default Description Example
broadcast interface{} interface{} Configuration on which direktiv operations will trigger coud events on the namespace

Set a Namespace Variable (setNamespaceVariable)

PUT /api/namespaces/{namespace}/vars/{variable}

Set the value sorted in a namespace variable. If the target variable does not exists, it will be created. Variable data can be anything.

Consumes

  • text/plain

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
variable path string string target variable
data body string string Payload that contains variable data.

All responses

Code Status Description Has headers Schema
200 OK successfully set namespace variable schema

Responses

200 - successfully set namespace variable

Status: OK

Schema

Set Cloud Event for Workflow to Log to (setWorkflowCloudEventLogs)

POST /api/namespaces/{namespace}/tree/{workflow}?op=set-workflow-event-logging

Set Cloud Event for Workflow to Log to. When configured type direktiv.instanceLog cloud events will be generated with the logger parameter set to the configured value. Workflows can be configured to generate cloud events on their namespace anything the log parameter produces data. Please find more information on this topic here: https://docs.direktiv.io/docs/examples/logging.html

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
Cloud Event Logger body SetWorkflowCloudEventLogsBody SetWorkflowCloudEventLogsBody Cloud event logger to target

All responses

Code Status Description Has headers Schema
200 OK successfully update workflow schema

Responses

200 - successfully update workflow

Status: OK

Schema
Inlined models

SetWorkflowCloudEventLogsBody

Properties

Name Type Go type Required Default Description Example
logger string string Target Cloud Event

Set a Workflow Variable (setWorkflowVariable)

PUT /api/namespaces/{namespace}/tree/{workflow}?op=set-var

Set the value sorted in a workflow variable. If the target variable does not exists, it will be created. Variable data can be anything.

Consumes

  • text/plain

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
var query string string target variable
data body string string Payload that contains variable data.

All responses

Code Status Description Has headers Schema
200 OK successfully set workflow variable schema

Responses

200 - successfully set workflow variable

Status: OK

Schema

Set Cloud Event for Workflow to Log to (toggleWorkflow)

POST /api/namespaces/{namespace}/tree/{workflow}?op=toggle

Toggle's whether or not a workflow is active. Disabled workflows cannot be invoked. This includes start event and scheduled workflows.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
Workflow Live Status body ToggleWorkflowBody ToggleWorkflowBody Whether or not the workflow is alive or disabled

All responses

Code Status Description Has headers Schema
200 OK successfully updated workflow live status schema

Responses

200 - successfully updated workflow live status

Status: OK

Schema
Inlined models

ToggleWorkflowBody

Properties

Name Type Go type Required Default Description Example
live boolean bool Workflow live status

Create Global Service Revision (updateGlobalService)

POST /api/functions/{serviceName}

Creates a new global scoped knative service revision Revisions are created with a traffic percentage. This percentage controls how much traffic will be directed to this revision. Traffic can be set to 100 to direct all traffic.

Parameters

Name Source Type Go type Separator Required Default Description
serviceName path string string target service name
Service body UpdateGlobalServiceBody UpdateGlobalServiceBody Payload that contains information on service revision

All responses

Code Status Description Has headers Schema
200 OK successfully created service revision schema

Responses

200 - successfully created service revision

Status: OK

Schema
Inlined models

UpdateGlobalServiceBody

Properties

Name Type Go type Required Default Description Example
cmd string string
image string string Target image a service will use
minScale integer int64 Minimum amount of service pods to be live
size string string Size of created service pods
trafficPercent integer int64 Traffic percentage new revision will use

Update Global Service Traffic (updateGlobalServiceTraffic)

PATCH /api/functions/{serviceName}

Update Global Service traffic directed to each revision, traffic can only be configured between two revisions. All other revisions will bet set to 0 traffic.

Parameters

Name Source Type Go type Separator Required Default Description
serviceName path string string target service name
Service Traffic body UpdateGlobalServiceTrafficBody UpdateGlobalServiceTrafficBody Payload that contains information on service traffic

All responses

Code Status Description Has headers Schema
200 OK successfully updated service traffic schema

Responses

200 - successfully updated service traffic

Status: OK

Schema
Inlined models

UpdateGlobalServiceTrafficBody

Properties

Name Type Go type Required Default Description Example
values []UpdateGlobalServiceTrafficParamsBodyValuesItems0 []*models.UpdateGlobalServiceTrafficParamsBodyValuesItems0 List of revision traffic targets

UpdateGlobalServiceTrafficParamsBodyValuesItems0

Properties

Name Type Go type Required Default Description Example
percent integer int64 Target traffice percentage
revision string string Target service revision

Create Namespace Service Revision (updateNamespaceService)

POST /api/functions/namespaces/{namespace}/function/{serviceName}

Creates a new namespace scoped knative service revision. Revisions are created with a traffic percentage. This percentage controls how much traffic will be directed to this revision. Traffic can be set to 100 to direct all traffic.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
serviceName path string string target service name
Service body UpdateNamespaceServiceBody UpdateNamespaceServiceBody Payload that contains information on service revision

All responses

Code Status Description Has headers Schema
200 OK successfully created service revision schema

Responses

200 - successfully created service revision

Status: OK

Schema
Inlined models

UpdateNamespaceServiceBody

Properties

Name Type Go type Required Default Description Example
cmd string string
image string string Target image a service will use
minScale integer int64 Minimum amount of service pods to be live
size string string Size of created service pods
trafficPercent integer int64 Traffic percentage new revision will use

Update Namespace Service Traffic (updateNamespaceServiceTraffic)

PATCH /api/functions/namespaces/{namespace}/function/{serviceName}

Update Namespace Service traffic directed to each revision, traffic can only be configured between two revisions. All other revisions will bet set to 0 traffic.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
serviceName path string string target service name
Service Traffic body UpdateNamespaceServiceTrafficBody UpdateNamespaceServiceTrafficBody Payload that contains information on service traffic

All responses

Code Status Description Has headers Schema
200 OK successfully updated service traffic schema

Responses

200 - successfully updated service traffic

Status: OK

Schema
Inlined models

UpdateNamespaceServiceTrafficBody

Properties

Name Type Go type Required Default Description Example
values []UpdateNamespaceServiceTrafficParamsBodyValuesItems0 []*models.UpdateNamespaceServiceTrafficParamsBodyValuesItems0 List of revision traffic targets

UpdateNamespaceServiceTrafficParamsBodyValuesItems0

Properties

Name Type Go type Required Default Description Example
percent integer int64 Target traffice percentage
revision string string Target service revision

Update a Workflow (updateWorkflow)

POST /api/namespaces/{namespace}/tree/{workflow}?op=update-workflow

Updates a workflow at the target path. The body of this request should contain the workflow yaml you want to update to.

Consumes

  • text/plain

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow
workflow data body string string Payload that contains the updated direktiv workflow yaml.

All responses

Code Status Description Has headers Schema
200 OK successfully updated workflow schema

Responses

200 - successfully updated workflow

Status: OK

Schema

Returns version information for servers in the cluster. (version)

GET /api/version

Returns version information for servers in the cluster.

All responses

Code Status Description Has headers Schema
200 OK version query was successful schema

Responses

200 - version query was successful

Status: OK

Schema

Watch Global Service Revision (watchGlobalServiceRevision)

GET /api/functions/{serviceName}/revisions/{revisionGeneration}

Watch a global scoped knative service revision. The target revision generation is the number suffix on a revision. Example: A revision named 'global-fast-request-00003' would have the revisionGeneration '00003'. Note: This is a Server-Sent-Event endpoint, and will not work with the default swagger client.

Produces

  • text/event-stream

Parameters

Name Source Type Go type Separator Required Default Description
revisionGeneration path string string target revision generation
serviceName path string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully watching service revision schema

Responses

200 - successfully watching service revision

Status: OK

Schema

Watch Global Service Revision List (watchGlobalServiceRevisionList)

GET /api/functions/{serviceName}/revisions

Watch the revision list of a global scoped knative service. Note: This is a Server-Sent-Event endpoint, and will not work with the default swagger client.

Produces

  • text/event-stream

Parameters

Name Source Type Go type Separator Required Default Description
serviceName path string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully watching service revisions schema

Responses

200 - successfully watching service revisions

Status: OK

Schema

Watch Namespace Service Revision (watchNamespaceServiceRevision)

GET /api/functions/namespaces/{namespace}/function/{serviceName}/revisions/{revisionGeneration}

Watch a namespace scoped knative service revision. The target revision generation is the number suffix on a revision. Example: A revision named 'namespace-direktiv-fast-request-00003' would have the revisionGeneration '00003'. Note: This is a Server-Sent-Event endpoint, and will not work with the default swagger client.

Produces

  • text/event-stream

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
revisionGeneration path string string target revision generation
serviceName path string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully watching service revision schema

Responses

200 - successfully watching service revision

Status: OK

Schema

Watch Namespace Service Revision List (watchNamespaceServiceRevisionList)

GET /api/functions/namespaces/{namespace}/function/{serviceName}/revisions

Watch the revision list of a namespace scoped knative service. Note: This is a Server-Sent-Event endpoint, and will not work with the default swagger client.

Produces

  • text/event-stream

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
serviceName path string string target service name

All responses

Code Status Description Has headers Schema
200 OK successfully watching service revisions schema

Responses

200 - successfully watching service revisions

Status: OK

Schema

Gets Invoked Workflow Metrics (workflowMetricsInvoked)

GET /api/namespaces/{namespace}/tree/{workflow}?op=metrics-invoked

Get metrics of invoked workflow instances.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow

All responses

Code Status Description Has headers Schema
200 OK successfully got workflow metrics schema

Responses

200 - successfully got workflow metrics

Status: OK

Schema

Gets Workflow Time Metrics (workflowMetricsMilliseconds)

GET /api/namespaces/{namespace}/tree/{workflow}?op=metrics-failed

Get the timing metrics of a workflow's instance. This returns a total sum of the milliseconds a workflow has been executed for.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow

All responses

Code Status Description Has headers Schema
200 OK successfully got workflow metrics schema

Responses

200 - successfully got workflow metrics

Status: OK

Schema

Gets a Workflow State Time Metrics (workflowMetricsStateMilliseconds)

GET /api/namespaces/{namespace}/tree/{workflow}?op=metrics-state-milliseconds

Get the state timing metrics of a workflow's instance. This returns the timing of individual states in a workflow.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow

All responses

Code Status Description Has headers Schema
200 OK successfully got workflow metrics schema

Responses

200 - successfully got workflow metrics

Status: OK

Schema

Gets Successful Workflow Metrics (workflowMetricsSuccessful)

GET /api/namespaces/{namespace}/tree/{workflow}?op=metrics-successful

Get metrics of a workflow, where the instance was successful.

Parameters

Name Source Type Go type Separator Required Default Description
namespace path string string target namespace
workflow path string string path to target workflow

All responses

Code Status Description Has headers Schema
200 OK successfully got workflow metrics schema

Responses

200 - successfully got workflow metrics

Status: OK

Schema

Models

CreateGlobalPrivateRegistryBody

CreateGlobalPrivateRegistryBody create global private registry body

Example

{"data":"admin:8QwFLg%D$qg*","reg":"https://prod.customreg.io"}

Properties

Name Type Go type Required Default Description Example
Data string string Target registry connection data containing the user and token.
Reg string string Target registry URL

CreateGlobalRegistryBody

CreateGlobalRegistryBody create global registry body

Example

{"data":"admin:8QwFLg%D$qg*","reg":"https://prod.customreg.io"}

Properties

Name Type Go type Required Default Description Example
Data string string Target registry connection data containing the user and token.
Reg string string Target registry URL

CreateGlobalServiceBody

CreateGlobalServiceBody create global service body

Example

{"cmd":"","image":"direktiv/request:v12","minScale":"1","name":"fast-request","size":"small"}

Properties

Name Type Go type Required Default Description Example
Cmd string string cmd
Image string string Target image a service will use
MinScale int64 (formatted integer) int64 Minimum amount of service pods to be live
Name string string Name of new service
Size string string Size of created service pods

CreateNamespaceServiceBody

CreateNamespaceServiceBody create namespace service body

Example

{"cmd":"","image":"direktiv/request:v12","minScale":"1","name":"fast-request","size":"small"}

Properties

Name Type Go type Required Default Description Example
Cmd string string cmd
Image string string Target image a service will use
MinScale int64 (formatted integer) int64 Minimum amount of service pods to be live
Name string string Name of new service
Size string string Size of created service pods

CreateRegistryBody

CreateRegistryBody create registry body

Example

{"data":"admin:8QwFLg%D$qg*","reg":"https://prod.customreg.io"}

Properties

Name Type Go type Required Default Description Example
Data string string Target registry connection data containing the user and token.
Reg string string Target registry URL

DeleteGlobalPrivateRegistryBody

DeleteGlobalPrivateRegistryBody delete global private registry body

Example

{"data":"admin:8QwFLg%D$qg*","reg":"https://prod.customreg.io"}

Properties

Name Type Go type Required Default Description Example
Reg string string Target registry URL

DeleteGlobalRegistryBody

DeleteGlobalRegistryBody delete global registry body

Example

{"data":"admin:8QwFLg%D$qg*","reg":"https://prod.customreg.io"}

Properties

Name Type Go type Required Default Description Example
Reg string string Target registry URL

DeleteRegistryBody

DeleteRegistryBody delete registry body

Example

{"data":"admin:8QwFLg%D$qg*","reg":"https://prod.customreg.io"}

Properties

Name Type Go type Required Default Description Example
Reg string string Target registry URL

ErrorResponse

Properties

Name Type Go type Required Default Description Example
Error string string
StatusCode int64 (formatted integer) int64

JqPlaygroundBody

JqPlaygroundBody jq playground body

Example

{"data":"eyJhIjogMSwgImIiOiAyLCAiYyI6IDQsICJkIjogN30=","query":"map(select(. \u003e= 2))"}

Properties

Name Type Go type Required Default Description Example
Data string string JSON data encoded in base64
Query string string jq query to manipulate JSON data

OkBody

OkBody OkBody is an arbitrary placeholder response that represents an ok response body

OkBody

SetNamespaceConfigBody

SetNamespaceConfigBody set namespace config body

Example

{"broadcast":{"directory.create":false,"directory.delete":false,"instance.failed":false,"instance.started":false,"instance.success":false,"instance.variable.create":false,"instance.variable.delete":false,"instance.variable.update":false,"namespace.variable.create":false,"namespace.variable.delete":false,"namespace.variable.update":false,"workflow.create":false,"workflow.delete":false,"workflow.update":false,"workflow.variable.create":false,"workflow.variable.delete":false,"workflow.variable.update":false}}

Properties

Name Type Go type Required Default Description Example
Broadcast interface{} interface{} Configuration on which direktiv operations will trigger coud events on the namespace

SetWorkflowCloudEventLogsBody

SetWorkflowCloudEventLogsBody set workflow cloud event logs body

Example

{"logger":"mylog"}

Properties

Name Type Go type Required Default Description Example
Logger string string Target Cloud Event

ToggleWorkflowBody

ToggleWorkflowBody toggle workflow body

Example

{"live":false}

Properties

Name Type Go type Required Default Description Example
Live boolean bool Workflow live status

UpdateGlobalServiceBody

UpdateGlobalServiceBody update global service body

Example

{"cmd":"","image":"direktiv/request:v10","minScale":"1","size":"small","trafficPercent":50}

Properties

Name Type Go type Required Default Description Example
Cmd string string cmd
Image string string Target image a service will use
MinScale int64 (formatted integer) int64 Minimum amount of service pods to be live
Size string string Size of created service pods
TrafficPercent int64 (formatted integer) int64 Traffic percentage new revision will use

UpdateGlobalServiceTrafficBody

UpdateGlobalServiceTrafficBody update global service traffic body

Example

{"values":[{"percent":60,"revision":"global-fast-request-00002"},{"percent":40,"revision":"global-fast-request-00001"}]}

Properties

Name Type Go type Required Default Description Example
Values []UpdateGlobalServiceTrafficParamsBodyValuesItems0 []*UpdateGlobalServiceTrafficParamsBodyValuesItems0 List of revision traffic targets

UpdateGlobalServiceTrafficParamsBodyValuesItems0

UpdateGlobalServiceTrafficParamsBodyValuesItems0 update global service traffic params body values items0

Properties

Name Type Go type Required Default Description Example
Percent int64 (formatted integer) int64 Target traffice percentage
Revision string string Target service revision

UpdateNamespaceServiceBody

UpdateNamespaceServiceBody update namespace service body

Example

{"cmd":"","image":"direktiv/request:v10","minScale":"1","size":"small","trafficPercent":50}

Properties

Name Type Go type Required Default Description Example
Cmd string string cmd
Image string string Target image a service will use
MinScale int64 (formatted integer) int64 Minimum amount of service pods to be live
Size string string Size of created service pods
TrafficPercent int64 (formatted integer) int64 Traffic percentage new revision will use

UpdateNamespaceServiceTrafficBody

UpdateNamespaceServiceTrafficBody update namespace service traffic body

Example

{"values":[{"percent":60,"revision":"namespace-direktiv-fast-request-00002"},{"percent":40,"revision":"namespace-direktiv-fast-request-00001"}]}

Properties

Name Type Go type Required Default Description Example
Values []UpdateNamespaceServiceTrafficParamsBodyValuesItems0 []*UpdateNamespaceServiceTrafficParamsBodyValuesItems0 List of revision traffic targets

UpdateNamespaceServiceTrafficParamsBodyValuesItems0

UpdateNamespaceServiceTrafficParamsBodyValuesItems0 update namespace service traffic params body values items0

Properties

Name Type Go type Required Default Description Example
Percent int64 (formatted integer) int64 Target traffice percentage
Revision string string Target service revision

UpdateServiceRequest

UpdateServiceRequest UpdateServiceRequest UpdateServiceRequest update service request

Properties

Name Type Go type Required Default Description Example
Cmd string string cmd
Image string string image
MinScale int32 (formatted integer) int32 minScale
Size int32 (formatted integer) int32 size
TrafficPercent int64 (formatted integer) int64 trafficPercent

updateServiceRequest

UpdateServiceRequest UpdateServiceRequest update service request

Properties

Name Type Go type Required Default Description Example
Cmd string string cmd
Image string string image
MinScale int32 (formatted integer) int32 minScale
Size int32 (formatted integer) int32 size
TrafficPercent int64 (formatted integer) int64 trafficPercent
Back to top