Processes

Download schema

A process is a started application with specific user inputs on a given platform

List all processes

GET

https://api.scaleway.com

/qaas/v1alpha1/processes

Retrieve information about all processes.

List all processes › query Parameters

project_id

string · required

List processes belonging to this project ID. (UUID format)

application_id

string

List processes that have been created for this application.

tags

string[]

List processes with these tags.

page

integer · int32

Page number.

page_size

integer · uint32

Maximum number of processes to return per page.

order_by

string · enum

Sort order of the returned processes.

Enum values:

created_at_desc

created_at_asc

name_asc

name_desc

started_at_asc

started_at_desc

status_asc

status_desc

Default: created_at_desc

List all processes › Responses

200

scaleway.qaas.v1alpha1.ListProcessesResponse

total_count

integer · uint64

Total number of processes.

scaleway.qaas.v1alpha1.Process[]

List of processes.

GET/qaas/v1alpha1/processes

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/qaas/v1alpha1/processes?project_id=6170692e-7363-616c-6577-61792e636f6d"

Example Responses

{
  "total_count": 0,
  "processes": [
    {
      "id": "id",
      "name": "name",
      "application_id": "application_id",
      "platform_id": "platform_id",
      "attached_session_ids": [
        "string"
      ],
      "created_at": "2022-03-22T12:34:56.123456Z",
      "started_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "finished_at": "2022-03-22T12:34:56.123456Z",
      "status": "unknown_status",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "tags": [
        "string"
      ],
      "progress": 0,
      "progress_message": "progress_message",
      "input": "input"
    }
  ]
}

json

application/json

Create a process

POST

https://api.scaleway.com

/qaas/v1alpha1/processes

Create a new process for the specified application on a specified platform.

Create a process › Request Body

project_id

string · required

ID of the project in which the process was created. (UUID format)

platform_id

string · required

ID of the platform for which the process was created.

application_id

string · required

ID of the application for which the process was created.

name

string

Name of the process.

input

string

Process parameters in JSON format.

tags

string[]

Tags of the process.

Create a process › Responses

200

scaleway.qaas.v1alpha1.Process

id

string

Unique ID of the process.

name

string

Name of the process.

application_id

string

Application ID for which the process has been created.

platform_id

string

Platform ID for which the process has been created.

attached_session_ids

string[]

List of sessions generated by the process.

created_at

string · date-time

Time at which the process was created. (RFC 3339 format)

started_at

string · date-time

Time at which the process started. (RFC 3339 format)

updated_at

string · date-time

Time at which the process was updated. (RFC 3339 format)

finished_at

string · date-time

Time at which the process was finished. (RFC 3339 format)

status

string · enum

Status of the process.

Enum values:

unknown_status

error

starting

running

completed

cancelling

cancelled

Default: unknown_status

project_id

string

Project ID in which the process has been created. (UUID format)

tags

string[]

Tags of the process.

progress

integer · uint32

Progress of the process, from 0 to 1.

progress_message

string

Any progress of the process.

input

string

Input payload of the process as JSON string.

POST/qaas/v1alpha1/processes

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "application_id": "string",
    "name": "string",
    "platform_id": "string",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d"
  }' \
  "https://api.scaleway.com/qaas/v1alpha1/processes"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "platform_id": "platform_id",
  "application_id": "application_id",
  "name": "name",
  "input": "input",
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "application_id": "application_id",
  "platform_id": "platform_id",
  "attached_session_ids": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "started_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "finished_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "tags": [
    "string"
  ],
  "progress": 0,
  "progress_message": "progress_message",
  "input": "input"
}

json

application/json

Get process information

GET

https://api.scaleway.com

/qaas/v1alpha1/processes/{process_id}

Retrieve information about the provided process ID, such as name, status and progress.

Get process information › path Parameters

process_id

string · required

Unique ID of the process.

Get process information › Responses

200

scaleway.qaas.v1alpha1.Process

id

string

Unique ID of the process.

name

string

Name of the process.

application_id

string

Application ID for which the process has been created.

platform_id

string

Platform ID for which the process has been created.

attached_session_ids

string[]

List of sessions generated by the process.

created_at

string · date-time

Time at which the process was created. (RFC 3339 format)

started_at

string · date-time

Time at which the process started. (RFC 3339 format)

updated_at

string · date-time

Time at which the process was updated. (RFC 3339 format)

finished_at

string · date-time

Time at which the process was finished. (RFC 3339 format)

status

string · enum

Status of the process.

Enum values:

unknown_status

error

starting

running

completed

cancelling

cancelled

Default: unknown_status

project_id

string

Project ID in which the process has been created. (UUID format)

tags

string[]

Tags of the process.

progress

integer · uint32

Progress of the process, from 0 to 1.

progress_message

string

Any progress of the process.

input

string

Input payload of the process as JSON string.

Delete an existing process

DELETE

https://api.scaleway.com

/qaas/v1alpha1/processes/{process_id}

Delete a process by its unique ID and delete all its data.

Delete an existing process › path Parameters

process_id

string · required

Unique ID of the process.

Delete an existing process › Responses

No data returned

Update process information

PATCH

https://api.scaleway.com

/qaas/v1alpha1/processes/{process_id}

Update process information of the provided process ID.

Update process information › path Parameters

process_id

string · required

Unique ID of the process.

Update process information › Request Body

name

string

Name of the process.

tags

string[]

Tags of the process.

Update process information › Responses

200

scaleway.qaas.v1alpha1.Process

id

string

Unique ID of the process.

name

string

Name of the process.

application_id

string

Application ID for which the process has been created.

platform_id

string

Platform ID for which the process has been created.

attached_session_ids

string[]

List of sessions generated by the process.

created_at

string · date-time

Time at which the process was created. (RFC 3339 format)

started_at

string · date-time

Time at which the process started. (RFC 3339 format)

updated_at

string · date-time

Time at which the process was updated. (RFC 3339 format)

finished_at

string · date-time

Time at which the process was finished. (RFC 3339 format)

status

string · enum

Status of the process.

Enum values:

unknown_status

error

starting

running

completed

cancelling

cancelled

Default: unknown_status

project_id

string

Project ID in which the process has been created. (UUID format)

tags

string[]

Tags of the process.

progress

integer · uint32

Progress of the process, from 0 to 1.

progress_message

string

Any progress of the process.

input

string

Input payload of the process as JSON string.

PATCH/qaas/v1alpha1/processes/{process_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/qaas/v1alpha1/processes/{process_id}"

Example Request Body

{
  "name": "name",
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "application_id": "application_id",
  "platform_id": "platform_id",
  "attached_session_ids": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "started_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "finished_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "tags": [
    "string"
  ],
  "progress": 0,
  "progress_message": "progress_message",
  "input": "input"
}

json

application/json

Cancel a running process

POST

https://api.scaleway.com

/qaas/v1alpha1/processes/{process_id}/cancel

Cancel a process by its unique ID. Intermediate results are still available.

Cancel a running process › path Parameters

process_id

string · required

Unique ID of the process.

Cancel a running process › Request Body

Cancel a running process › Responses

200

scaleway.qaas.v1alpha1.Process

id

string

Unique ID of the process.

name

string

Name of the process.

application_id

string

Application ID for which the process has been created.

platform_id

string

Platform ID for which the process has been created.

attached_session_ids

string[]

List of sessions generated by the process.

created_at

string · date-time

Time at which the process was created. (RFC 3339 format)

started_at

string · date-time

Time at which the process started. (RFC 3339 format)

updated_at

string · date-time

Time at which the process was updated. (RFC 3339 format)

finished_at

string · date-time

Time at which the process was finished. (RFC 3339 format)

status

string · enum

Status of the process.

Enum values:

unknown_status

error

starting

running

completed

cancelling

cancelled

Default: unknown_status

project_id

string

Project ID in which the process has been created. (UUID format)

tags

string[]

Tags of the process.

progress

integer · uint32

Progress of the process, from 0 to 1.

progress_message

string

Any progress of the process.

input

string

Input payload of the process as JSON string.

POST/qaas/v1alpha1/processes/{process_id}/cancel

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/qaas/v1alpha1/processes/{process_id}/cancel"

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "application_id": "application_id",
  "platform_id": "platform_id",
  "attached_session_ids": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "started_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "finished_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "tags": [
    "string"
  ],
  "progress": 0,
  "progress_message": "progress_message",
  "input": "input"
}

json

application/json

List all results of a process

GET

https://api.scaleway.com

/qaas/v1alpha1/processes/{process_id}/results

Retrieve all intermediate and final result of a process.

List all results of a process › path Parameters

process_id

string · required

ID of the process.

List all results of a process › query Parameters

page

integer · int32

Page number.

page_size

integer · uint32

Maximum number of results to return per page.

order_by

string · enum

Sort order of the returned results.

Enum values:

created_at_desc

created_at_asc

Default: created_at_desc

List all results of a process › Responses

200

scaleway.qaas.v1alpha1.ListProcessResultsResponse

total_count

integer · uint64

Total number of results.

scaleway.qaas.v1alpha1.ProcessResult[]

List of results.

Applications Bookings

List all processes

GET

https://api.scaleway.com

/qaas/v1alpha1/processes

Retrieve information about all processes.

List all processes › query Parameters

project_id

string · required

List processes belonging to this project ID. (UUID format)

application_id

string

List processes that have been created for this application.

tags

string[]

List processes with these tags.

page

integer · int32

Page number.

page_size

integer · uint32

Maximum number of processes to return per page.

order_by

string · enum

Sort order of the returned processes.

Enum values:

created_at_desc

created_at_asc

name_asc

name_desc

started_at_asc

started_at_desc

status_asc

status_desc

Default: created_at_desc

List all processes › Responses

200

scaleway.qaas.v1alpha1.ListProcessesResponse

total_count

integer · uint64

Total number of processes.

scaleway.qaas.v1alpha1.Process[]

List of processes.

Create a process

POST

https://api.scaleway.com

/qaas/v1alpha1/processes

Create a new process for the specified application on a specified platform.

Create a process › Request Body

project_id

string · required

ID of the project in which the process was created. (UUID format)

platform_id

string · required

ID of the platform for which the process was created.

application_id

string · required

ID of the application for which the process was created.

name

string

Name of the process.

input

string

Process parameters in JSON format.

tags

string[]

Tags of the process.

Create a process › Responses

200

scaleway.qaas.v1alpha1.Process

id

string

Unique ID of the process.

name

string

Name of the process.

application_id

string

Application ID for which the process has been created.

platform_id

string

Platform ID for which the process has been created.

attached_session_ids

string[]

List of sessions generated by the process.

created_at

string · date-time

Time at which the process was created. (RFC 3339 format)

started_at

string · date-time

Time at which the process started. (RFC 3339 format)

updated_at

string · date-time

Time at which the process was updated. (RFC 3339 format)

finished_at

string · date-time

Time at which the process was finished. (RFC 3339 format)

status

string · enum

Status of the process.

Enum values:

unknown_status

error

starting

running

completed

cancelling

cancelled

Default: unknown_status

project_id

string

Project ID in which the process has been created. (UUID format)

tags

string[]

Tags of the process.

progress

integer · uint32

Progress of the process, from 0 to 1.

progress_message

string

Any progress of the process.

input

string

Input payload of the process as JSON string.

Get process information

GET

https://api.scaleway.com

/qaas/v1alpha1/processes/{process_id}

Retrieve information about the provided process ID, such as name, status and progress.

Get process information › path Parameters

process_id

string · required

Unique ID of the process.

Get process information › Responses

200

scaleway.qaas.v1alpha1.Process

id

string

Unique ID of the process.

name

string

Name of the process.

application_id

string

Application ID for which the process has been created.

platform_id

string

Platform ID for which the process has been created.

attached_session_ids

string[]

List of sessions generated by the process.

created_at

string · date-time

Time at which the process was created. (RFC 3339 format)

started_at

string · date-time

Time at which the process started. (RFC 3339 format)

updated_at

string · date-time

Time at which the process was updated. (RFC 3339 format)

finished_at

string · date-time

Time at which the process was finished. (RFC 3339 format)

status

string · enum

Status of the process.

Enum values:

unknown_status

error

starting

running

completed

cancelling

cancelled

Default: unknown_status

project_id

string

Project ID in which the process has been created. (UUID format)

tags

string[]

Tags of the process.

progress

integer · uint32

Progress of the process, from 0 to 1.

progress_message

string

Any progress of the process.

input

string

Input payload of the process as JSON string.

Update process information

PATCH

https://api.scaleway.com

/qaas/v1alpha1/processes/{process_id}

Update process information of the provided process ID.

Update process information › path Parameters

process_id

string · required

Unique ID of the process.

Update process information › Request Body

name

string

Name of the process.

tags

string[]

Tags of the process.

Update process information › Responses

200

scaleway.qaas.v1alpha1.Process

id

string

Unique ID of the process.

name

string

Name of the process.

application_id

string

Application ID for which the process has been created.

platform_id

string

Platform ID for which the process has been created.

attached_session_ids

string[]

List of sessions generated by the process.

created_at

string · date-time

Time at which the process was created. (RFC 3339 format)

started_at

string · date-time

Time at which the process started. (RFC 3339 format)

updated_at

string · date-time

Time at which the process was updated. (RFC 3339 format)

finished_at

string · date-time

Time at which the process was finished. (RFC 3339 format)

status

string · enum

Status of the process.

Enum values:

unknown_status

error

starting

running

completed

cancelling

cancelled

Default: unknown_status

project_id

string

Project ID in which the process has been created. (UUID format)

tags

string[]

Tags of the process.

progress

integer · uint32

Progress of the process, from 0 to 1.

progress_message

string

Any progress of the process.

input

string

Input payload of the process as JSON string.

Cancel a running process

POST

https://api.scaleway.com

/qaas/v1alpha1/processes/{process_id}/cancel

Cancel a process by its unique ID. Intermediate results are still available.

Cancel a running process › path Parameters

process_id

string · required

Unique ID of the process.

Cancel a running process › Request Body

Cancel a running process › Responses

200

scaleway.qaas.v1alpha1.Process

id

string

Unique ID of the process.

name

string

Name of the process.

application_id

string

Application ID for which the process has been created.

platform_id

string

Platform ID for which the process has been created.

attached_session_ids

string[]

List of sessions generated by the process.

created_at

string · date-time

Time at which the process was created. (RFC 3339 format)

started_at

string · date-time

Time at which the process started. (RFC 3339 format)

updated_at

string · date-time

Time at which the process was updated. (RFC 3339 format)

finished_at

string · date-time

Time at which the process was finished. (RFC 3339 format)

status

string · enum

Status of the process.

Enum values:

unknown_status

error

starting

running

completed

cancelling

cancelled

Default: unknown_status

project_id

string

Project ID in which the process has been created. (UUID format)

tags

string[]

Tags of the process.

progress

integer · uint32

Progress of the process, from 0 to 1.

progress_message

string

Any progress of the process.

input

string

Input payload of the process as JSON string.

List all results of a process

GET

https://api.scaleway.com

/qaas/v1alpha1/processes/{process_id}/results

Retrieve all intermediate and final result of a process.

List all results of a process › path Parameters

process_id

string · required

ID of the process.

List all results of a process › query Parameters

page

integer · int32

Page number.

page_size

integer · uint32

Maximum number of results to return per page.

order_by

string · enum

Sort order of the returned results.

Enum values:

created_at_desc

created_at_asc

Default: created_at_desc

List all results of a process › Responses

200

scaleway.qaas.v1alpha1.ListProcessResultsResponse

total_count

integer · uint64

Total number of results.

scaleway.qaas.v1alpha1.ProcessResult[]

List of results.