RunnerApi

All URIs are relative to http://localhost:8080

Method	HTTP request	Description
createRunner	POST /organizations/{organization_id}/workspaces/{workspace_id}/runners	Create a new Runner
createRunnerAccessControl	POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access	Add a control access to the Runner
deleteRunner	DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}	Delete a runner
deleteRunnerAccessControl	DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id}	Remove the specified access from the given Runner
getRunner	GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}	Get the details of a runner
getRunnerAccessControl	GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id}	Get a control access for the Runner
getRunnerSecurity	GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security	Get the Runner security information
listRunnerPermissions	GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/permissions/{role}	Get the Runner permission by given role
listRunnerSecurityUsers	GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/users	Get the Runner security users list
listRunners	GET /organizations/{organization_id}/workspaces/{workspace_id}/runners	List all Runners
startRun	POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/start	Start a run with runner parameters
stopRun	POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/stop	Stop the last run
updateRunner	PATCH /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}	Update a runner
updateRunnerAccessControl	PATCH /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id}	Update the specified access to User for a Runner
updateRunnerDefaultSecurity	PATCH /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/default	Set the Runner default security

createRunner

Runner createRunner(runnerCreateRequest)

Create a new runner for executing simulations. Use parentId to create a child runner that inherits configuration from a parent.

Example

import {
    RunnerApi,
    Configuration,
    RunnerCreateRequest
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerCreateRequest: RunnerCreateRequest; //the Runner to create

const { status, data } = await apiInstance.createRunner(
    organizationId,
    workspaceId,
    runnerCreateRequest
);

Parameters

Name	Type	Description	Notes
runnerCreateRequest	RunnerCreateRequest	the Runner to create
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined

Return type

Runner

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: application/json, application/yaml
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
201	the runner details	-
400	Bad request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createRunnerAccessControl

RunnerAccessControl createRunnerAccessControl(runnerAccessControl)

Grant access to a runner for a user or group. Valid roles: viewer, editor, validator (can validate runs), admin.

Example

import {
    RunnerApi,
    Configuration,
    RunnerAccessControl
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerId: string; //the Runner identifier (default to undefined)
let runnerAccessControl: RunnerAccessControl; //the new Runner security access to add.

const { status, data } = await apiInstance.createRunnerAccessControl(
    organizationId,
    workspaceId,
    runnerId,
    runnerAccessControl
);

Parameters

Name	Type	Description	Notes
runnerAccessControl	RunnerAccessControl	the new Runner security access to add.
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
runnerId	[string]	the Runner identifier	defaults to undefined

Return type

RunnerAccessControl

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: application/json, application/yaml
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
201	The Runner access	-
404	the Runner specified is unknown or you don't have access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteRunner

deleteRunner()

Delete a runner. Cannot delete while runs are in progress. Note: Child runners that reference this runner are not deleted automatically.

Example

import {
    RunnerApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerId: string; //the Runner identifier (default to undefined)

const { status, data } = await apiInstance.deleteRunner(
    organizationId,
    workspaceId,
    runnerId
);

Parameters

Name	Type	Description	Notes
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
runnerId	[string]	the Runner identifier	defaults to undefined

Return type

void (empty response body)

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Request succeeded	-
404	the Runner specified is unknown or you don't have access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteRunnerAccessControl

deleteRunnerAccessControl()

Example

import {
    RunnerApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerId: string; //the Runner identifier (default to undefined)
let identityId: string; //the User identifier (default to undefined)

const { status, data } = await apiInstance.deleteRunnerAccessControl(
    organizationId,
    workspaceId,
    runnerId,
    identityId
);

Parameters

Name	Type	Description	Notes
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
runnerId	[string]	the Runner identifier	defaults to undefined
identityId	[string]	the User identifier	defaults to undefined

Return type

void (empty response body)

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Request succeeded	-
404	the Runner or the user specified is unknown or you don't have access to them	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRunner

Runner getRunner()

Retrieve detailed information about a runner.

Example

import {
    RunnerApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerId: string; //the Runner identifier (default to undefined)

const { status, data } = await apiInstance.getRunner(
    organizationId,
    workspaceId,
    runnerId
);

Parameters

Name	Type	Description	Notes
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
runnerId	[string]	the Runner identifier	defaults to undefined

Return type

Runner

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	the Runner details	-
404	the Runner specified is unknown or you don't have access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRunnerAccessControl

RunnerAccessControl getRunnerAccessControl()

Example

import {
    RunnerApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerId: string; //the Runner identifier (default to undefined)
let identityId: string; //the User identifier (default to undefined)

const { status, data } = await apiInstance.getRunnerAccessControl(
    organizationId,
    workspaceId,
    runnerId,
    identityId
);

Parameters

Name	Type	Description	Notes
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
runnerId	[string]	the Runner identifier	defaults to undefined
identityId	[string]	the User identifier	defaults to undefined

Return type

RunnerAccessControl

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The Runner access	-
404	the Runner or user specified is unknown or you don't have access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRunnerSecurity

RunnerSecurity getRunnerSecurity()

Example

import {
    RunnerApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerId: string; //the Runner identifier (default to undefined)

const { status, data } = await apiInstance.getRunnerSecurity(
    organizationId,
    workspaceId,
    runnerId
);

Parameters

Name	Type	Description	Notes
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
runnerId	[string]	the Runner identifier	defaults to undefined

Return type

RunnerSecurity

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The Runner security	-
404	the Runner specified is unknown or you don't have access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listRunnerPermissions

Array listRunnerPermissions()

Example

import {
    RunnerApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerId: string; //the Runner identifier (default to undefined)
let role: string; //the Role (default to undefined)

const { status, data } = await apiInstance.listRunnerPermissions(
    organizationId,
    workspaceId,
    runnerId,
    role
);

Parameters

Name	Type	Description	Notes
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
runnerId	[string]	the Runner identifier	defaults to undefined
role	[string]	the Role	defaults to undefined

Return type

Array

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The Runners security permission list	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listRunnerSecurityUsers

Array listRunnerSecurityUsers()

Example

import {
    RunnerApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerId: string; //the Runner identifier (default to undefined)

const { status, data } = await apiInstance.listRunnerSecurityUsers(
    organizationId,
    workspaceId,
    runnerId
);

Parameters

Name	Type	Description	Notes
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
runnerId	[string]	the Runner identifier	defaults to undefined

Return type

Array

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The Runner security users list	-
404	the Runner specified is unknown or you don't have access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listRunners

Array listRunners()

Retrieve a paginated list of all runners in a workspace.

Example

import {
    RunnerApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let page: number; //Page number to query (first page is at index 0) (optional) (default to undefined)
let size: number; //Amount of result by page (optional) (default to undefined)

const { status, data } = await apiInstance.listRunners(
    organizationId,
    workspaceId,
    page,
    size
);

Parameters

Name	Type	Description	Notes
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
page	[number]	Page number to query (first page is at index 0)	(optional) defaults to undefined
size	[number]	Amount of result by page	(optional) defaults to undefined

Return type

Array

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	the list of Runners	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

startRun

CreatedRun startRun()

Start a new simulation run using the runner's current configuration. Returns the run Id. The run executes asynchronously - use the run status endpoint to monitor progress

Example

import {
    RunnerApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerId: string; //the Runner identifier (default to undefined)

const { status, data } = await apiInstance.startRun(
    organizationId,
    workspaceId,
    runnerId
);

Parameters

Name	Type	Description	Notes
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
runnerId	[string]	the Runner identifier	defaults to undefined

Return type

CreatedRun

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
202	the newly created Run info	-
404	the Runner specified is unknown or you don't have access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

stopRun

stopRun()

Stop the currently executing run for this runner. The stop operation is asynchronous - the run may continue briefly before stopping.

Example

import {
    RunnerApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerId: string; //the Runner identifier (default to undefined)

const { status, data } = await apiInstance.stopRun(
    organizationId,
    workspaceId,
    runnerId
);

Parameters

Name	Type	Description	Notes
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
runnerId	[string]	the Runner identifier	defaults to undefined

Return type

void (empty response body)

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
202	the last Run has been stopped	-
404	the Runner specified is unknown or you don't have access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateRunner

Runner updateRunner(runnerUpdateRequest)

Example

import {
    RunnerApi,
    Configuration,
    RunnerUpdateRequest
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerId: string; //the Runner identifier (default to undefined)
let runnerUpdateRequest: RunnerUpdateRequest; //the new Runner details. This endpoint can\'t be used to update security

const { status, data } = await apiInstance.updateRunner(
    organizationId,
    workspaceId,
    runnerId,
    runnerUpdateRequest
);

Parameters

Name	Type	Description	Notes
runnerUpdateRequest	RunnerUpdateRequest	the new Runner details. This endpoint can't be used to update security
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
runnerId	[string]	the Runner identifier	defaults to undefined

Return type

Runner

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: application/json, application/yaml
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	the runner details	-
400	Bad request	-
404	the Runner specified is unknown or you don't have access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateRunnerAccessControl

RunnerAccessControl updateRunnerAccessControl(runnerRole)

Example

import {
    RunnerApi,
    Configuration,
    RunnerRole
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerId: string; //the Runner identifier (default to undefined)
let identityId: string; //the User identifier (default to undefined)
let runnerRole: RunnerRole; //The new Runner Access Control

const { status, data } = await apiInstance.updateRunnerAccessControl(
    organizationId,
    workspaceId,
    runnerId,
    identityId,
    runnerRole
);

Parameters

Name	Type	Description	Notes
runnerRole	RunnerRole	The new Runner Access Control
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
runnerId	[string]	the Runner identifier	defaults to undefined
identityId	[string]	the User identifier	defaults to undefined

Return type

RunnerAccessControl

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: application/json, application/yaml
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The Runner access	-
404	The Organization specified is unknown or you don't have access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateRunnerDefaultSecurity

RunnerSecurity updateRunnerDefaultSecurity(runnerRole)

Example

import {
    RunnerApi,
    Configuration,
    RunnerRole
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunnerApi(configuration);

let organizationId: string; //the Organization identifier (default to undefined)
let workspaceId: string; //the Workspace identifier (default to undefined)
let runnerId: string; //the Runner identifier (default to undefined)
let runnerRole: RunnerRole; //This change the runner default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the runner.

const { status, data } = await apiInstance.updateRunnerDefaultSecurity(
    organizationId,
    workspaceId,
    runnerId,
    runnerRole
);

Parameters

Name	Type	Description	Notes
runnerRole	RunnerRole	This change the runner default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the runner.
organizationId	[string]	the Organization identifier	defaults to undefined
workspaceId	[string]	the Workspace identifier	defaults to undefined
runnerId	[string]	the Runner identifier	defaults to undefined

Return type

RunnerSecurity

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: application/json, application/yaml
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
201	The Runner default visibility	-
404	the Runner specified is unknown or you don't have access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

RunnerApi.md

Latest commit

History

RunnerApi.md

File metadata and controls

RunnerApi

createRunner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createRunnerAccessControl

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteRunner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteRunnerAccessControl

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getRunner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getRunnerAccessControl

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getRunnerSecurity

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listRunnerPermissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listRunnerSecurityUsers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listRunners

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

startRun

Example

Parameters