Events

Download schema

An event is a record of any activity related to your Scaleway resources, encompassing actions by users, applications, or Scaleway.

List events

GET

https://api.scaleway.com

/audit-trail/v1alpha1/regions/{region}/events

Retrieve the list of Audit Trail events for a Scaleway Organization and/or Project. You must specify the organization_id and optionally, the project_id.

List events › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

List events › query Parameters

organization_id

string · required

ID of the Organization containing the Audit Trail events.

project_id

string

(Optional) ID of the Project containing the Audit Trail events.

resource_type

string · enum

(Optional) Type of the Scaleway resource.

Enum values:

unknown_type

secm_secret

secm_secret_version

kube_cluster

kube_pool

kube_node

kube_acl

keym_key

Default: unknown_type

method_name

string

(Optional) Name of the method of the API call performed.

status

integer · uint32

(Optional) HTTP status code of the request. Returns either 200 if the request was successful or 403 if the permission was denied.

recorded_after

string · date-time

(Optional) The recorded_after parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns one hour ago by default. (RFC 3339 format)

recorded_before

string · date-time

(Optional) The recorded_before parameter defines the latest timestamp up to which Audit Trail events are retrieved. Returns now by default. (RFC 3339 format)

order_by

scaleway.audit_trail.v1alpha1.ListEventsRequest.OrderBy · enum

Enum values:

recorded_at_desc

recorded_at_asc

Default: recorded_at_desc

page_size

integer · uint32

page_token

string

product_name

string

(Optional) Name of the Scaleway product in a hyphenated format.

service_name

string

(Optional) Name of the service of the API call performed.

resource_id

string

(Optional) ID of the Scaleway resource.

principal_id

string

(Optional) ID of the User or IAM application at the origin of the event.

source_ip

string

(Optional) IP address at the origin of the event.

List events › Responses

200

scaleway.audit_trail.v1alpha1.ListEventsResponse

scaleway.audit_trail.v1alpha1.Event[]

Single page of events matching the requested criteria.

next_page_token

string

Page token to use in following calls to keep listing.

GET/audit-trail/v1alpha1/regions/{region}/events

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/audit-trail/v1alpha1/regions/{region}/events?organization_id=string"

Example Responses

{
  "events": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "recorded_at": "2022-03-22T12:34:56.123456Z",
      "locality": "locality",
      "principal": {
        "id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "source_ip": "1.2.3.4",
      "user_agent": "user_agent",
      "product_name": "product_name",
      "service_name": "service_name",
      "method_name": "method_name",
      "resources": [
        {
          "id": "id",
          "type": "unknown_type",
          "created_at": "2022-03-22T12:34:56.123456Z",
          "updated_at": "2022-03-22T12:34:56.123456Z",
          "deleted_at": "2022-03-22T12:34:56.123456Z",
          "name": "name",
          "secm_secret_info": {
            "path": "path",
            "key_id": "key_id"
          },
          "secm_secret_version_info": {
            "revision": 0
          },
          "kube_cluster_info": {},
          "kube_pool_info": {
            "id": "id",
            "name": "name"
          },
          "kube_node_info": {
            "id": "id",
            "name": "name"
          },
          "kube_acl_info": {},
          "keym_key_info": {},
          "secret_manager_secret_info": {
            "path": "path",
            "key_id": "key_id"
          },
          "secret_manager_version_info": {
            "revision": 0
          },
          "key_manager_key_info": {},
          "account_user_info": {
            "email": "email",
            "phone_number": "phone_number"
          },
          "account_organization_info": {},
          "instance_server_info": {
            "name": "name"
          },
          "apple_silicon_server_info": {
            "id": "id",
            "name": "name"
          },
          "account_project_info": {
            "description": "description"
          },
          "baremetal_server_info": {
            "description": "description",
            "tags": [
              "string"
            ]
          },
          "baremetal_setting_info": {
            "type": "type"
          },
          "ipam_ip_info": {
            "address": "1.2.3.4/32"
          },
          "load_balancer_lb_info": {
            "name": "name"
          },
          "load_balancer_ip_info": {
            "ip_address": "ip_address",
            "lb_id": "lb_id"
          },
          "load_balancer_frontend_info": {
            "lb_id": "lb_id",
            "name": "name"
          },
          "load_balancer_backend_info": {
            "lb_id": "lb_id",
            "name": "name"
          },
          "load_balancer_route_info": {
            "frontend_id": "frontend_id",
            "backend_id": "backend_id"
          },
          "load_balancer_acl_info": {
            "frontend_id": "frontend_id"
          },
          "load_balancer_certificate_info": {
            "lb_id": "lb_id",
            "name": "name"
          },
          "edge_services_plan_info": {},
          "edge_services_pipeline_info": {
            "name": "name"
          },
          "edge_services_dns_stage_info": {
            "pipeline_id": "pipeline_id"
          },
          "edge_services_tls_stage_info": {
            "pipeline_id": "pipeline_id"
          },
          "edge_services_cache_stage_info": {
            "pipeline_id": "pipeline_id"
          },
          "edge_services_route_stage_info": {
            "pipeline_id": "pipeline_id"
          },
          "edge_services_route_rules_info": {
            "route_stage_id": "route_stage_id"
          },
          "edge_services_waf_stage_info": {
            "pipeline_id": "pipeline_id"
          },
          "edge_services_backend_stage_info": {
            "pipeline_id": "pipeline_id"
          },
          "account_contract_signature_info": {
            "signed_at": "2022-03-22T12:34:56.123456Z",
            "signed_by_account_root_user_id": "signed_by_account_root_user_id",
            "expires_at": "2022-03-22T12:34:56.123456Z",
            "contract": {
              "id": "id",
              "type": "type",
              "name": "name",
              "version": 0,
              "created_at": "2022-03-22T12:34:56.123456Z",
              "updated_at": "2022-03-22T12:34:56.123456Z"
            }
          },
          "vpc_subnet_info": {
            "subnet_cidr": "1.2.3.4/32",
            "vpc_id": "6170692e-7363-616c-6577-61792e636f6d"
          },
          "vpc_route_info": {
            "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
            "destination": "1.2.3.4/32",
            "nexthop_resource_key": "6170692e-7363-616c-6577-61792e636f6d",
            "nexthop_private_network_key": "6170692e-7363-616c-6577-61792e636f6d"
          },
          "vpc_private_network_info": {
            "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
            "push_default_route": true
          },
          "audit_trail_export_job_info": {},
          "vpc_gw_gateway_info": {
            "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
            "gateway_type_id": "6170692e-7363-616c-6577-61792e636f6d",
            "public_ip_id": "6170692e-7363-616c-6577-61792e636f6d"
          },
          "vpc_gw_gateway_network_info": {
            "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
            "pn_id": "6170692e-7363-616c-6577-61792e636f6d",
            "address": "1.2.3.4/32"
          },
          "apple_silicon_runner_info": {
            "id": "id",
            "name": "name"
          },
          "audit_trail_alert_rule_info": {},
          "vpc_connector_info": {
            "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
            "target_vpc_id": "6170692e-7363-616c-6577-61792e636f6d"
          },
          "instance_private_network_interface_info": {
            "private_network_id": "private_network_id",
            "server_id": "server_id",
            "security_group_id": "security_group_id"
          }
        }
      ],
      "request_id": "6170692e-7363-616c-6577-61792e636f6d",
      "request_body": {
        "<fieldKey>": {}
      },
      "status_code": 0
    }
  ],
  "next_page_token": "next_page_token"
}

json

application/json

Create an export job

POST

https://api.scaleway.com

/audit-trail/v1alpha1/regions/{region}/export-jobs

Create an export job for a specified organization. This allows you to export audit trail events to a destination, such as an S3 bucket. The request requires the organization ID, a name for the export, and a destination configuration.

Create an export job › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

Create an export job › Request Body

organization_id

string

ID of the Organization to target.

name

string

Name of the export.

object

The configuration specifying the bucket where the audit trail events will be exported.

tags

string[]

Tags of the export.

Create an export job › Responses

200

scaleway.audit_trail.v1alpha1.ExportJob

id

string

ID of the export job. (UUID format)

organization_id

string

ID of the targeted Organization. (UUID format)

name

string

Name of the export job.

object

Destination in an S3 storage.

created_at

string · date-time

Export job creation date. (RFC 3339 format)

last_run_at

string · date-time

Last run of export job. (RFC 3339 format)

tags

string[]

Tags of the export job.

object

Status of last export job.

POST/audit-trail/v1alpha1/regions/{region}/export-jobs

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","organization_id":"string"}' \
  "https://api.scaleway.com/audit-trail/v1alpha1/regions/{region}/export-jobs"

Example Request Body

{
  "organization_id": "organization_id",
  "name": "name",
  "s3": {
    "bucket": "bucket",
    "region": "region",
    "prefix": "prefix",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "s3": {
    "bucket": "bucket",
    "region": "region",
    "prefix": "prefix",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "created_at": "2022-03-22T12:34:56.123456Z",
  "last_run_at": "2022-03-22T12:34:56.123456Z",
  "tags": [
    "string"
  ],
  "last_status": {
    "code": "unknown_code",
    "message": "message"
  }
}

json

application/json

Delete an export job

DELETE

https://api.scaleway.com

/audit-trail/v1alpha1/regions/{region}/export-jobs/{export_job_id}

Deletes an export job for a specified id.

Delete an export job › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

export_job_id

string · required

ID of the export job.

Delete an export job › Responses

No data returned

Retrieve the list of Scaleway resources for which you have Audit Trail events

GET

https://api.scaleway.com

/audit-trail/v1alpha1/regions/{region}/products

Retrieve the list of Scaleway resources for which you have Audit Trail events › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

Retrieve the list of Scaleway resources for which you have Audit Trail events › query Parameters

organization_id

string · required

ID of the Organization containing the Audit Trail events.

Retrieve the list of Scaleway resources for which you have Audit Trail events › Responses

200

scaleway.audit_trail.v1alpha1.ListProductsResponse

scaleway.audit_trail.v1alpha1.Product[]

List of all products integrated with Audit Trail.

total_count

integer · uint64

Number of integrated products.

Authentication events

List events

GET

https://api.scaleway.com

/audit-trail/v1alpha1/regions/{region}/events

Retrieve the list of Audit Trail events for a Scaleway Organization and/or Project. You must specify the organization_id and optionally, the project_id.

List events › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

List events › query Parameters

organization_id

string · required

ID of the Organization containing the Audit Trail events.

project_id

string

(Optional) ID of the Project containing the Audit Trail events.

resource_type

string · enum

(Optional) Type of the Scaleway resource.

Enum values:

unknown_type

secm_secret

secm_secret_version

kube_cluster

kube_pool

kube_node

kube_acl

keym_key

Default: unknown_type

method_name

string

(Optional) Name of the method of the API call performed.

status

integer · uint32

(Optional) HTTP status code of the request. Returns either 200 if the request was successful or 403 if the permission was denied.

recorded_after

string · date-time

(Optional) The recorded_after parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns one hour ago by default. (RFC 3339 format)

recorded_before

string · date-time

(Optional) The recorded_before parameter defines the latest timestamp up to which Audit Trail events are retrieved. Returns now by default. (RFC 3339 format)

order_by

scaleway.audit_trail.v1alpha1.ListEventsRequest.OrderBy · enum

Enum values:

recorded_at_desc

recorded_at_asc

Default: recorded_at_desc

page_size

integer · uint32

page_token

string

product_name

string

(Optional) Name of the Scaleway product in a hyphenated format.

service_name

string

(Optional) Name of the service of the API call performed.

resource_id

string

(Optional) ID of the Scaleway resource.

principal_id

string

(Optional) ID of the User or IAM application at the origin of the event.

source_ip

string

(Optional) IP address at the origin of the event.

List events › Responses

200

scaleway.audit_trail.v1alpha1.ListEventsResponse

scaleway.audit_trail.v1alpha1.Event[]

Single page of events matching the requested criteria.

next_page_token

string

Page token to use in following calls to keep listing.

Create an export job

POST

https://api.scaleway.com

/audit-trail/v1alpha1/regions/{region}/export-jobs

Create an export job › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

Create an export job › Request Body

organization_id

string

ID of the Organization to target.

name

string

Name of the export.

object

The configuration specifying the bucket where the audit trail events will be exported.

tags

string[]

Tags of the export.

Create an export job › Responses

200

scaleway.audit_trail.v1alpha1.ExportJob

id

string

ID of the export job. (UUID format)

organization_id

string

ID of the targeted Organization. (UUID format)

name

string

Name of the export job.

object

Destination in an S3 storage.

created_at

string · date-time

Export job creation date. (RFC 3339 format)

last_run_at

string · date-time

Last run of export job. (RFC 3339 format)

tags

string[]

Tags of the export job.

object

Status of last export job.

Delete an export job

DELETE

https://api.scaleway.com

/audit-trail/v1alpha1/regions/{region}/export-jobs/{export_job_id}

Deletes an export job for a specified id.

Delete an export job › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

export_job_id

string · required

ID of the export job.

Delete an export job › Responses

No data returned

Retrieve the list of Scaleway resources for which you have Audit Trail events

GET

https://api.scaleway.com

/audit-trail/v1alpha1/regions/{region}/products

Retrieve the list of Scaleway resources for which you have Audit Trail events › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

Retrieve the list of Scaleway resources for which you have Audit Trail events › query Parameters

organization_id

string · required

ID of the Organization containing the Audit Trail events.

Retrieve the list of Scaleway resources for which you have Audit Trail events › Responses

200

scaleway.audit_trail.v1alpha1.ListProductsResponse

scaleway.audit_trail.v1alpha1.Product[]

List of all products integrated with Audit Trail.

total_count

integer · uint64

Number of integrated products.