Scaleway logo
Audit Trail API
Audit Trail API

Schemas

Download schema

scaleway.audit_trail.v1alpha1.AccountContractSignatureInfo

signed_at
​string | null · date-time

(RFC 3339 format)

signed_by_account_root_user_id
​string
expires_at
​string | null · date-time

(RFC 3339 format)

scaleway.audit_trail.v1alpha1.AccountContractSignatureInfo.AccountContractInfo

id
​string
type
​string
name
​string
version
​integer · int32
created_at
​string | null · date-time

(RFC 3339 format)

updated_at
​string | null · date-time

(RFC 3339 format)

scaleway.audit_trail.v1alpha1.AccountOrganizationInfo

scaleway.audit_trail.v1alpha1.AccountProjectInfo

description
​string

scaleway.audit_trail.v1alpha1.AccountUserInfo

email
​string
phone_number
​string | null

scaleway.audit_trail.v1alpha1.Action

string · enum
Enum values:
unknown_action
create
update
delete
Default: unknown_action

scaleway.audit_trail.v1alpha1.AlertRule

id
​string

ID of the alert rule. (UUID format)

srn
​string · pattern: ^srn://audit-trail\.…

The SRN of the alert rule.

name
​string

Name of the alert rule.

description
​string

Description of the alert rule.

Current status of the alert rule.

Enum values:
unknown_status
enabled
disabled
enabling
disabling
Default: unknown_status
region
​string

Region of the alert rule.

scaleway.audit_trail.v1alpha1.AlertRule.Status

string · enum
Enum values:
unknown_status
enabled
disabled
enabling
disabling
Default: unknown_status

scaleway.audit_trail.v1alpha1.AppleSiliconRunnerInfo

id
​string
name
​string

scaleway.audit_trail.v1alpha1.AppleSiliconServerInfo

id
​string
name
​string

scaleway.audit_trail.v1alpha1.AuditTrailAlertRuleInfo

scaleway.audit_trail.v1alpha1.AuditTrailCustomAlertRuleInfo

scaleway.audit_trail.v1alpha1.AuditTrailExportJobInfo

scaleway.audit_trail.v1alpha1.AuthenticationEvent

id
​string

ID of the event. (UUID format)

recorded_at
​string | null · date-time

Timestamp of the event. (RFC 3339 format)

organization_id
​string

Organization ID containing the event. (UUID format)

source_ip
​string

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

user_agent
​string | null

User Agent at the origin of the event.

Resources attached to the event.

Result of the authentication attempt.

Enum values:
unknown_result
success
failure
Default: unknown_result

(Optional) Reason for authentication failure.

Enum values:
unknown_failure_reason
invalid_mfa
invalid_password
invalid_captcha
invalid_authentication_code
invalid_passkey
passkey_uv_not_met
passkey_uv_not_verified
Default: unknown_failure_reason
country_code
​scaleway.std.CountryCode · enum

(Optional) ISO 3166-1 alpha-2 country code of the source IP.

Enum values:
unknown_country_code
AF
AX
AL
DZ
AS
AD
AO
Default: unknown_country_code

Authentication method used.

Enum values:
unknown_method
password
authentication_code
oauth2
saml
passkey
Default: unknown_method

Origin of the authentication attempt.

Enum values:
unknown_origin
public_api
admin_api
Default: unknown_origin

(Optional) MFA type used for the authentication attempt.

Enum values:
unknown_mfa_type
totp
webauthn
Default: unknown_mfa_type

scaleway.audit_trail.v1alpha1.AuthenticationEvent.FailureReason

string · enum
Enum values:
unknown_failure_reason
invalid_mfa
invalid_password
invalid_captcha
invalid_authentication_code
invalid_passkey
passkey_uv_not_met
passkey_uv_not_verified
Default: unknown_failure_reason

scaleway.audit_trail.v1alpha1.AuthenticationEvent.MFAType

string · enum
Enum values:
unknown_mfa_type
totp
webauthn
Default: unknown_mfa_type

scaleway.audit_trail.v1alpha1.AuthenticationEvent.Method

string · enum
Enum values:
unknown_method
password
authentication_code
oauth2
saml
passkey
Default: unknown_method

scaleway.audit_trail.v1alpha1.AuthenticationEvent.Origin

string · enum
Enum values:
unknown_origin
public_api
admin_api
Default: unknown_origin

scaleway.audit_trail.v1alpha1.AuthenticationEvent.Result

string · enum
Enum values:
unknown_result
success
failure
Default: unknown_result

scaleway.audit_trail.v1alpha1.BaremetalServerInfo

description
​string
tags
​string[]

scaleway.audit_trail.v1alpha1.BaremetalSettingInfo

type
​string

scaleway.audit_trail.v1alpha1.CustomAlertRule

id
​string

ID of the alert rule. (UUID format)

srn
​string · pattern: ^srn://audit-trail\.…

The SRN of the alert rule.

name
​string

Name of the alert rule.

description
​string | null

(Optional) Description of the alert rule.

Current status of the alert rule.

Enum values:
unknown_status
enabled
disabled
enabling
disabling
Default: unknown_status
query
​string

The Common Expression Language (CEL) string defining the logic for the alert rule.

evaluation_window
​string | null

The duration of time over which to evaluate the rule (how far back to look for matching events). (in seconds)

occurrences
​integer · uint32

The minimum number of matched occurrences required within the evaluation window to trigger the alert.

The severity level assigned to the custom alert rule.

Enum values:
unknown_severity
info
error
warning
critical
Default: unknown_severity
created_at
​string | null · date-time

Custom alert rule creation date. (RFC 3339 format)

updated_at
​string | null · date-time

Custom alert rule last modification date. (RFC 3339 format)

region
​string

Region of the alert rule.

scaleway.audit_trail.v1alpha1.CustomAlertRule.Severity

string · enum
Enum values:
unknown_severity
info
error
warning
critical
Default: unknown_severity

scaleway.audit_trail.v1alpha1.CustomAlertRule.Status

string · enum
Enum values:
unknown_status
enabled
disabled
enabling
disabling
Default: unknown_status

scaleway.audit_trail.v1alpha1.CustomAlertRuleField

name
​string

The field name to be used in the CEL expression (e.g., productName, status).

The expected data type of the field within the CEL environment.

Enum values:
unknown_field_type
field_type_string
field_type_int
Default: unknown_field_type
​

A list of string CEL operators that are supported and valid for this field.

​

A list of int CEL operators that are supported and valid for this field.

scaleway.audit_trail.v1alpha1.CustomAlertRuleField.FieldType

string · enum
Enum values:
unknown_field_type
field_type_string
field_type_int
Default: unknown_field_type

scaleway.audit_trail.v1alpha1.CustomAlertRuleField.IntOperator

string · enum
Enum values:
unknown_int_operator
int_equal
int_not_equal
int_less_than_or_equal
int_less_than
int_greater_than_or_equal
int_greater_than
Default: unknown_int_operator

scaleway.audit_trail.v1alpha1.CustomAlertRuleField.IntOperators

Enum values:
unknown_int_operator
int_equal
int_not_equal
int_less_than_or_equal
int_less_than
int_greater_than_or_equal
int_greater_than

scaleway.audit_trail.v1alpha1.CustomAlertRuleField.StringOperator

string · enum
Enum values:
unknown_string_operator
string_contains
string_matches
string_starts_with
string_ends_with
string_equal
string_not_equal
Default: unknown_string_operator

scaleway.audit_trail.v1alpha1.CustomAlertRuleField.StringOperators

Enum values:
unknown_string_operator
string_contains
string_matches
string_starts_with
string_ends_with
string_equal
string_not_equal

scaleway.audit_trail.v1alpha1.DisableAlertRulesResponse

List of the preconfigured rules that were disabled.

scaleway.audit_trail.v1alpha1.DisableCustomAlertRulesResponse

List of the custom rules that were disabled.

scaleway.audit_trail.v1alpha1.EdgeServicesBackendStageInfo

pipeline_id
​string | null

scaleway.audit_trail.v1alpha1.EdgeServicesCacheStageInfo

pipeline_id
​string | null

scaleway.audit_trail.v1alpha1.EdgeServicesDNSStageInfo

pipeline_id
​string | null

scaleway.audit_trail.v1alpha1.EdgeServicesPipelineInfo

name
​string

scaleway.audit_trail.v1alpha1.EdgeServicesPlanInfo

scaleway.audit_trail.v1alpha1.EdgeServicesRouteRulesInfo

route_stage_id
​string

scaleway.audit_trail.v1alpha1.EdgeServicesRouteStageInfo

pipeline_id
​string | null

scaleway.audit_trail.v1alpha1.EdgeServicesTLSStageInfo

pipeline_id
​string | null

scaleway.audit_trail.v1alpha1.EdgeServicesVPCEndpointInfo

private_network_id
​string

(UUID format)

scaleway.audit_trail.v1alpha1.EdgeServicesWAFStageInfo

pipeline_id
​string | null

scaleway.audit_trail.v1alpha1.EnableAlertRulesResponse

List of the preconfigured rules that were enabled.

scaleway.audit_trail.v1alpha1.EnableCustomAlertRulesResponse

List of the custom rules that were enabled.

scaleway.audit_trail.v1alpha1.Event

id
​string

ID of the event. (UUID format)

recorded_at
​string | null · date-time

Timestamp of the event. (RFC 3339 format)

locality
​string

Locality of the resource attached to the event.

​

User or IAM application at the origin of the event.

organization_id
​string

Organization ID containing the event. (UUID format)

project_id
​string | null

(Optional) Project of the resource attached to the event. (UUID format)

source_ip
​string

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

user_agent
​string | null

User Agent at the origin of the event.

product_name
​string

Product name of the resource attached to the event.

service_name
​string

API name called to trigger the event.

method_name
​string

API method called to trigger the event.

Resources attached to the event.

request_id
​string

Unique identifier of the request at the origin of the event. (UUID format)

​object

Request at the origin of the event.

status_code
​integer · uint32

HTTP status code resulting of the API call.

scaleway.audit_trail.v1alpha1.Event.Principal

id
​string

(UUID format)

scaleway.audit_trail.v1alpha1.EventsOverview

scaleway.audit_trail.v1alpha1.ExportJob

id
​string

ID of the export job. (UUID format)

srn
​string · pattern: ^srn://audit-trail\.…

The SRN of the export job.

organization_id
​string

ID of the targeted Organization. (UUID format)

name
​string

Name of the export job.

​

Destination in an S3 storage.

created_at
​string | null · date-time

Export job creation date. (RFC 3339 format)

last_run_at
​string | null · date-time

Last run of export job. (RFC 3339 format)

tags
​string[]

Tags of the export job.

Status of last export job.

region
​string

Region of the export job.

scaleway.audit_trail.v1alpha1.ExportJob.S3

bucket
​string · pattern: ^[a-z0-9][a-z0-9.-]{…
region
​string · pattern: ^[a-z]{2}-[a-z]{3}$

The region you want to target

prefix
​string | null · pattern: ^[a-zA-Z0-9\._\-]+(?…
project_id
​string | null

(UUID format)

scaleway.audit_trail.v1alpha1.ExportJob.Status

Enum values:
unknown_code
success
failure
Default: unknown_code
message
​string | null

scaleway.audit_trail.v1alpha1.ExportJob.Status.Code

string · enum
Enum values:
unknown_code
success
failure
Default: unknown_code

scaleway.audit_trail.v1alpha1.InstancePrivateNetworkInterfaceInfo

private_network_id
​string
server_id
​string | null
security_group_id
​string | null

scaleway.audit_trail.v1alpha1.InstanceServerInfo

name
​string

scaleway.audit_trail.v1alpha1.IpamIpInfo

address
​string

(IP network)

scaleway.audit_trail.v1alpha1.KeyManagerKeyInfo

scaleway.audit_trail.v1alpha1.KubernetesACLInfo

scaleway.audit_trail.v1alpha1.KubernetesClusterInfo

scaleway.audit_trail.v1alpha1.KubernetesNodeInfo

id
​string
name
​string

scaleway.audit_trail.v1alpha1.KubernetesPoolInfo

id
​string
name
​string

scaleway.audit_trail.v1alpha1.ListAlertRulesResponse

Single page of preconfigured alert rules matching the requested criteria.

total_count
​integer · uint64

Total count of alert rules matching the requested criteria.

scaleway.audit_trail.v1alpha1.ListAuthenticationEventsRequest.OrderBy

string · enum
Enum values:
recorded_at_desc
recorded_at_asc
Default: recorded_at_desc

scaleway.audit_trail.v1alpha1.ListAuthenticationEventsResponse

next_page_token
​string | null

scaleway.audit_trail.v1alpha1.ListCombinedEventsRequest.OrderBy

string · enum
Enum values:
recorded_at_desc
recorded_at_asc
Default: recorded_at_desc

scaleway.audit_trail.v1alpha1.ListCombinedEventsResponse

next_page_token
​string | null

scaleway.audit_trail.v1alpha1.ListCombinedEventsResponse.CombinedEvent

​
​
​

scaleway.audit_trail.v1alpha1.ListCustomAlertRulesResponse

Single page of custom alert rules matching the requested criteria.

total_count
​integer · uint64

Total count of custom alert rules matching the requested criteria.

scaleway.audit_trail.v1alpha1.ListEventsRequest.OrderBy

string · enum
Enum values:
recorded_at_desc
recorded_at_asc
Default: recorded_at_desc

scaleway.audit_trail.v1alpha1.ListEventsResponse

Single page of events matching the requested criteria.

next_page_token
​string | null

Page token to use in following calls to keep listing.

scaleway.audit_trail.v1alpha1.ListExportJobsRequest.OrderBy

string · enum
Enum values:
name_asc
name_desc
created_at_asc
created_at_desc
Default: name_asc

scaleway.audit_trail.v1alpha1.ListExportJobsResponse

Single page of export jobs matching the requested criteria.

total_count
​integer · uint64

Total count of export jobs matching the requested criteria.

scaleway.audit_trail.v1alpha1.ListProductsResponse

List of all products integrated with Audit Trail.

total_count
​integer · uint64

Number of integrated products.

scaleway.audit_trail.v1alpha1.ListSystemEventsRequest.OrderBy

string · enum
Enum values:
recorded_at_desc
recorded_at_asc
Default: recorded_at_desc

scaleway.audit_trail.v1alpha1.ListSystemEventsResponse

Single page of system events matching the requested criteria.

next_page_token
​string | null

Page token to use in following calls to keep listing.

scaleway.audit_trail.v1alpha1.LoadBalancerAclInfo

frontend_id
​string

scaleway.audit_trail.v1alpha1.LoadBalancerBackendInfo

lb_id
​string
name
​string

scaleway.audit_trail.v1alpha1.LoadBalancerCertificateInfo

lb_id
​string
name
​string

scaleway.audit_trail.v1alpha1.LoadBalancerFrontendInfo

lb_id
​string
name
​string

scaleway.audit_trail.v1alpha1.LoadBalancerIpInfo

ip_address
​string
lb_id
​string | null

scaleway.audit_trail.v1alpha1.LoadBalancerLbInfo

name
​string

scaleway.audit_trail.v1alpha1.LoadBalancerRouteInfo

frontend_id
​string
backend_id
​string

scaleway.audit_trail.v1alpha1.ObservabilityAlertRuleInfo

rule_ids
​string[]

(UUID format)

scaleway.audit_trail.v1alpha1.ObservabilityContactPointInfo

email
​string

scaleway.audit_trail.v1alpha1.Product

title
​string

Product title.

name
​string

Product name.

Specifies the API versions of the products integrated with Audit Trail. Each version defines the methods logged by Audit Trail.

scaleway.audit_trail.v1alpha1.Product.Service

name
​string
methods
​string[]

scaleway.audit_trail.v1alpha1.Resource

id
​string
type
​scaleway.audit_trail.v1alpha1.ResourceType · enum
Enum values:
unknown_type
secm_secret
secm_secret_version
kube_cluster
kube_pool
kube_node
kube_acl
keym_key
Default: unknown_type
created_at
​string | null · date-time

(RFC 3339 format)

updated_at
​string | null · date-time

(RFC 3339 format)

deleted_at
​string | null · date-time

(RFC 3339 format)

name
​string | null
action
​scaleway.audit_trail.v1alpha1.Action · enum
Enum values:
unknown_action
create
update
delete
Default: unknown_action
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​

scaleway.audit_trail.v1alpha1.ResourceType

string · enum
Enum values:
unknown_type
secm_secret
secm_secret_version
kube_cluster
kube_pool
kube_node
kube_acl
keym_key
Default: unknown_type

scaleway.audit_trail.v1alpha1.RetrieveAvailableFieldsForCustomAlertRulesResponse

A list of fields that are authorized to be used in a CEL expression.

total_count
​integer · uint64

Number of fields.

scaleway.audit_trail.v1alpha1.RunStatus

string · enum
Enum values:
unknown_run_status
initialized
validated
queued
running
succeeded
failed
interrupting
Default: unknown_run_status

scaleway.audit_trail.v1alpha1.SecretManagerSecretInfo

path
​string
key_id
​string | null

scaleway.audit_trail.v1alpha1.SecretManagerSecretVersionInfo

revision
​integer · uint32

scaleway.audit_trail.v1alpha1.ServerlessContainersContainerInfo

namespace_id
​string

(UUID format)

scaleway.audit_trail.v1alpha1.ServerlessContainersDomainInfo

container_id
​string

(UUID format)

scaleway.audit_trail.v1alpha1.ServerlessContainersNamespaceInfo

scaleway.audit_trail.v1alpha1.ServerlessContainersTriggerInfo

container_id
​string

(UUID format)

Enum values:
unknown_source_type
cron
sqs
nats
Default: unknown_source_type

scaleway.audit_trail.v1alpha1.ServerlessContainersTriggerInfo.SourceType

string · enum
Enum values:
unknown_source_type
cron
sqs
nats
Default: unknown_source_type

scaleway.audit_trail.v1alpha1.ServerlessFunctionsCronInfo

function_id
​string

(UUID format)

scaleway.audit_trail.v1alpha1.ServerlessFunctionsDomainInfo

function_id
​string

(UUID format)

scaleway.audit_trail.v1alpha1.ServerlessFunctionsFunctionInfo

namespace_id
​string

(UUID format)

scaleway.audit_trail.v1alpha1.ServerlessFunctionsNamespaceInfo

scaleway.audit_trail.v1alpha1.ServerlessFunctionsTriggerInfo

function_id
​string

(UUID format)

Enum values:
unknown_input_type
scw_sqs
scw_nats
Default: unknown_input_type

scaleway.audit_trail.v1alpha1.ServerlessFunctionsTriggerInfo.InputType

string · enum
Enum values:
unknown_input_type
scw_sqs
scw_nats
Default: unknown_input_type

scaleway.audit_trail.v1alpha1.SetEnabledAlertRulesResponse

List of the preconfigured rules that were enabled.

scaleway.audit_trail.v1alpha1.SetEnabledCustomAlertRulesResponse

List of the custom rules that were enabled.

scaleway.audit_trail.v1alpha1.SystemEvent

id
​string

ID of the system event. (UUID format)

recorded_at
​string | null · date-time

Timestamp of the system event. (RFC 3339 format)

locality
​string

Locality of the system event.

organization_id
​string

Organization ID containing the system event.

project_id
​string | null

Project of the resource attached to the system event. (UUID format)

product_name
​string

Name of the Scaleway product in a hyphenated format.

source
​string

Source of the system event.

system_name
​string

Name of the jobs, notification, etc.

Resources attached to the event.

Source of the event (unknown, cron or notification).

Enum values:
unknown_kind
cron
notification
Default: unknown_kind

scaleway.audit_trail.v1alpha1.SystemEvent.Kind

string · enum
Enum values:
unknown_kind
cron
notification
Default: unknown_kind

scaleway.audit_trail.v1alpha1.TestCustomAlertRuleResponse

firing
​boolean

True when the alert rule's condition is currently satisfied, false otherwise. A false return value does not mean the alert rule is incorrect, only that it is not currently firing.

scaleway.audit_trail.v1alpha1.VpcConnectorInfo

vpc_id
​string

(UUID format)

target_vpc_id
​string

(UUID format)

scaleway.audit_trail.v1alpha1.VpcGwGatewayInfo

vpc_id
​string | null

(UUID format)

gateway_type_id
​string

(UUID format)

public_ip_id
​string | null

(UUID format)

scaleway.audit_trail.v1alpha1.VpcGwGatewayNetworkInfo

gateway_id
​string

(UUID format)

pn_id
​string

(UUID format)

address
​string | null

(IP network)

scaleway.audit_trail.v1alpha1.VpcIngressRuleInfo

vpc_id
​string

(UUID format)

source
​string

(IP network)

nexthop_private_network_id
​string

(UUID format)

nexthop_resource_ip
​string

(IP address)

scaleway.audit_trail.v1alpha1.VpcPrivateNetworkInfo

vpc_id
​string

(UUID format)

push_default_route
​boolean

scaleway.audit_trail.v1alpha1.VpcRouteInfo

vpc_id
​string

(UUID format)

destination
​string

(IP network)

nexthop_resource_key
​string | null

(UUID format)

nexthop_private_network_key
​string | null

(UUID format)

scaleway.audit_trail.v1alpha1.VpcSubnetInfo

subnet_cidr
​string

(IP network)

vpc_id
​string

(UUID format)

scaleway.audit_trail.v1alpha1.WoflWorkflowDefinitionInfo

name
​string
description
​string | null

scaleway.audit_trail.v1alpha1.WoflWorkflowRunInfo

workflow_definition_id
​string
workflow_definition_name
​string | null
status
​scaleway.audit_trail.v1alpha1.RunStatus · enum
Enum values:
unknown_run_status
initialized
validated
queued
running
succeeded
failed
interrupting
Default: unknown_run_status

scaleway.audit_trail.v1alpha1.WoflWorkflowVersionInfo

workflow_definition_id
​string
workflow_definition_name
​string | null
name
​string

scaleway.std.CountryCode

string · enum
Enum values:
unknown_country_code
AF
AX
AL
DZ
AS
AD
AO
Default: unknown_country_code