# Documentation for `scw audit-trail`


:::note{title="The CLI documentation pages are currently under construction"}
The content is up to date. We're making improvements to the site over the next few weeks for a better experience.
:::

<!-- DO NOT EDIT: this file is automatically generated using scw-doc-gen -->
This API allows you to ensure accountability and security by recording events and changes performed within your Scaleway Organization.

- [Represent an entry in the Audit Trail](#represent-an-entry-in-the-audit-trail)
  - [List events](#list-events)
- [Product integrated with Audit Trail](#product-integrated-with-audit-trail)
  - [Retrieve the list of Scaleway resources for which you have Audit Trail events](#retrieve-the-list-of-scaleway-resources-for-which-you-have-audit-trail-events)


## Represent an entry in the Audit Trail

Represent an entry in the Audit Trail.


### List 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`.

**Usage:**

```shell
scw audit-trail event list [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| project-id |  | (Optional) ID of the Project containing the Audit Trail events |
| resource-type | One of: `unknown_type`, `secm_secret`, `secm_secret_version`, `kube_cluster`, `kube_pool`, `kube_node`, `kube_acl`, `keym_key`, `iam_user`, `iam_application`, `iam_group`, `iam_policy`, `iam_api_key`, `iam_ssh_key`, `iam_rule`, `iam_saml`, `iam_saml_certificate`, `iam_scim`, `iam_scim_token`, `secret_manager_secret`, `secret_manager_version`, `key_manager_key`, `account_user`, `account_organization`, `account_project`, `account_contract_signature`, `instance_server`, `instance_placement_group`, `instance_security_group`, `instance_volume`, `instance_snapshot`, `instance_image`, `instance_template`, `instance_private_network_interface`, `apple_silicon_server`, `baremetal_server`, `baremetal_setting`, `ipam_ip`, `sbs_volume`, `sbs_snapshot`, `load_balancer_lb`, `load_balancer_ip`, `load_balancer_frontend`, `load_balancer_backend`, `load_balancer_route`, `load_balancer_acl`, `load_balancer_certificate`, `sfs_filesystem`, `vpc_private_network`, `vpc_vpc`, `vpc_subnet`, `vpc_route`, `vpc_acl`, `vpc_connector`, `vpc_ingress_rule`, `edge_services_plan`, `edge_services_pipeline`, `edge_services_vpc_endpoint`, `edge_services_dns_stage`, `edge_services_tls_stage`, `edge_services_cache_stage`, `edge_services_route_stage`, `edge_services_route_rules`, `edge_services_waf_stage`, `edge_services_backend_stage`, `s2s_vpn_gateway`, `s2s_customer_gateway`, `s2s_routing_policy`, `s2s_connection`, `vpc_gw_gateway`, `vpc_gw_gateway_network`, `vpc_gw_dhcp`, `vpc_gw_dhcp_entry`, `vpc_gw_pat_rule`, `vpc_gw_ip`, `audit_trail_export_job`, `rdb_instance`, `rdb_instance_backup`, `rdb_instance_endpoint`, `rdb_instance_logs`, `rdb_instance_read_replica`, `rdb_instance_snapshot`, `mongodb_instance`, `mongodb_instance_snapshot`, `mongodb_instance_endpoint`, `mongodb_instance_maintenance`, `apple_silicon_runner`, `audit_trail_alert_rule`, `dtwh_deployment`, `dtwh_deployment_endpoint`, `dtwh_deployment_database`, `dtwh_deployment_user`, `ssdb_database`, `ssdb_database_backup`, `observability_datasource`, `observability_token`, `observability_exporter`, `ili_partner`, `ili_connection`, `ili_link`, `ili_routing_policy`, `autoscaling_group`, `gapi_dedicated_deployment`, `gapi_dedicated_model` | (Optional) Type of the Scaleway resource |
| method-name |  | (Optional) Name of the method of the API call performed |
| status |  | (Optional) HTTP status code of the request. Returns either `200` if the request was successful or `403` if the permission was denied |
| recorded-after |  | (Optional) The `recorded_after` parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns `one hour ago` by default |
| recorded-before |  | (Optional) The `recorded_before` parameter defines the latest timestamp up to which Audit Trail events are retrieved. Returns `now` by default |
| order-by | One of: `recorded_at_desc`, `recorded_at_asc` |  |
| page-size |  |  |
| page-token |  |  |
| product-name |  | (Optional) Name of the Scaleway product in a hyphenated format |
| service-name |  | (Optional) Name of the service of the API call performed |
| resource-id |  | (Optional) ID of the Scaleway resource |
| principal-id |  | (Optional) ID of the User or IAM application at the origin of the event |
| source-ip |  | (Optional) IP address at the origin of the event |
| organization-id |  | Organization ID to use. If none is passed the default organization ID will be used |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config |



## Product integrated with Audit Trail

Product integrated with Audit Trail.


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

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

**Usage:**

```shell
scw audit-trail product list [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| organization-id |  | Organization ID to use. If none is passed the default organization ID will be used |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config |