Runners

Download schema

A runner represents the configuration for a CI/CD runner that can be installed an a server.

List runner configurations associated with a server

GET

https://api.scaleway.com

/apple-silicon/v1alpha1/zones/{zone}/runners

List runner configurations associated with a server › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-3

List runner configurations associated with a server › query Parameters

server_id

string

ID of the server for which to list applied runner configurations. (UUID format)

project_id

string

Only list servers of this project ID. (UUID format)

organization_id

string

Only list servers of this Organization ID. (UUID format)

page

integer · int32

Positive integer to choose the page to return.

page_size

integer · uint32

Positive integer lower or equal to 100 to select the number of items to return.

List runner configurations associated with a server › Responses

200

scaleway.apple_silicon.v1alpha1.ListRunnersResponse

total_count

integer · uint64

scaleway.apple_silicon.v1alpha1.Runner[]

GET/apple-silicon/v1alpha1/zones/{zone}/runners

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/apple-silicon/v1alpha1/zones/{zone}/runners?server_id=6170692e-7363-616c-6577-61792e636f6d"

Example Responses

{
  "total_count": 0,
  "runners": [
    {
      "id": "id",
      "configuration": {
        "name": "name",
        "provider": "unknown_provider",
        "github_configuration": {
          "url": "url",
          "token": "token",
          "labels": [
            "string"
          ]
        },
        "gitlab_configuration": {
          "url": "url",
          "token": "token"
        }
      },
      "status": "unknown_status",
      "error_message": "error_message",
      "zone": "zone",
      "srn": "srn"
    }
  ]
}

json

application/json

Create a new runner configuration

POST

https://api.scaleway.com

/apple-silicon/v1alpha1/zones/{zone}/runners

Create a new runner configuration › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-3

Create a new runner configuration › Request Body

project_id

string · required

Creates a runner in the given project_id. (UUID format)

scaleway.apple_silicon.v1alpha1.RunnerConfigurationV2 · required

Configuration details for the runner.

Create a new runner configuration › Responses

200

scaleway.apple_silicon.v1alpha1.Runner

id

string

UUID of the runner.

scaleway.apple_silicon.v1alpha1.RunnerConfigurationV2

Configuration of the runner.

status

scaleway.apple_silicon.v1alpha1.Runner.Status · enum

Status of the runner.

Enum values:

unknown_status

waiting

enabled

disabled

error

Default: unknown_status

error_message

string

Error message of the runner (if any).

zone

string

Zone of the runner.

srn

string · pattern: ^srn://apple-silicon…

SRN of the runner.

POST/apple-silicon/v1alpha1/zones/{zone}/runners

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"6170692e-7363-616c-6577-61792e636f6d","runner_configuration":""}' \
  "https://api.scaleway.com/apple-silicon/v1alpha1/zones/{zone}/runners"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "runner_configuration": {
    "name": "name",
    "provider": "unknown_provider",
    "github_configuration": {
      "url": "url",
      "token": "token",
      "labels": [
        "string"
      ]
    },
    "gitlab_configuration": {
      "url": "url",
      "token": "token"
    }
  }
}

json

Example Responses

{
  "id": "id",
  "configuration": {
    "name": "name",
    "provider": "unknown_provider",
    "github_configuration": {
      "url": "url",
      "token": "token",
      "labels": [
        "string"
      ]
    },
    "gitlab_configuration": {
      "url": "url",
      "token": "token"
    }
  },
  "status": "unknown_status",
  "error_message": "error_message",
  "zone": "zone",
  "srn": "srn"
}

json

application/json

Retrieve a runner configuration

GET

https://api.scaleway.com

/apple-silicon/v1alpha1/zones/{zone}/runners/{runner_id}

Retrieve a runner configuration › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-3

runner_id

string · required

ID of the runner configuration to get. (UUID format)

Retrieve a runner configuration › Responses

200

scaleway.apple_silicon.v1alpha1.Runner

id

string

UUID of the runner.

scaleway.apple_silicon.v1alpha1.RunnerConfigurationV2

Configuration of the runner.

status

scaleway.apple_silicon.v1alpha1.Runner.Status · enum

Status of the runner.

Enum values:

unknown_status

waiting

enabled

disabled

error

Default: unknown_status

error_message

string

Error message of the runner (if any).

zone

string

Zone of the runner.

srn

string · pattern: ^srn://apple-silicon…

SRN of the runner.

Create a new runner configuration

PATCH

https://api.scaleway.com

/apple-silicon/v1alpha1/zones/{zone}/runners/{runner_id}

Create a new runner configuration › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-3

runner_id

string · required

ID of the runner configuration to update. (UUID format)

Create a new runner configuration › Request Body

scaleway.apple_silicon.v1alpha1.RunnerConfigurationV2 · required

Configuration details for the runner.

Create a new runner configuration › Responses

200

scaleway.apple_silicon.v1alpha1.Runner

id

string

UUID of the runner.

scaleway.apple_silicon.v1alpha1.RunnerConfigurationV2

Configuration of the runner.

status

scaleway.apple_silicon.v1alpha1.Runner.Status · enum

Status of the runner.

Enum values:

unknown_status

waiting

enabled

disabled

error

Default: unknown_status

error_message

string

Error message of the runner (if any).

zone

string

Zone of the runner.

srn

string · pattern: ^srn://apple-silicon…

SRN of the runner.

PATCH/apple-silicon/v1alpha1/zones/{zone}/runners/{runner_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"runner_configuration":""}' \
  "https://api.scaleway.com/apple-silicon/v1alpha1/zones/{zone}/runners/{runner_id}"

Example Request Body

{
  "runner_configuration": {
    "name": "name",
    "provider": "unknown_provider",
    "github_configuration": {
      "url": "url",
      "token": "token",
      "labels": [
        "string"
      ]
    },
    "gitlab_configuration": {
      "url": "url",
      "token": "token"
    }
  }
}

json

Example Responses

{
  "id": "id",
  "configuration": {
    "name": "name",
    "provider": "unknown_provider",
    "github_configuration": {
      "url": "url",
      "token": "token",
      "labels": [
        "string"
      ]
    },
    "gitlab_configuration": {
      "url": "url",
      "token": "token"
    }
  },
  "status": "unknown_status",
  "error_message": "error_message",
  "zone": "zone",
  "srn": "srn"
}

json

application/json

Create a new runner configuration

DELETE

https://api.scaleway.com

/apple-silicon/v1alpha1/zones/{zone}/runners/{runner_id}

Create a new runner configuration › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-3

runner_id

string · required

ID of the runner configuration to delete. (UUID format)

Create a new runner configuration › Responses

No data returned

OS Other endpoints