openapi: 3.1.0 info: title: Managed Database for PostgreSQL and MySQL Access Control List Triggers API description: "Managed Database for PostgreSQL and MySQL provides fully-managed relational Database Instances, with MySQL or PostgreSQL as database engines. The resource allows you to focus on development rather than administration or configuration. It comes with a high-availability mode, data replication, and automatic backups.\n\nCompared to traditional database management, which requires customers to provide their infrastructure and resources to manage their databases, Managed Database for PostgreSQL and MySQL Instance offers the user access to Database Instances without setting up the hardware or configuring the software. Scaleway handles the provisioning, manages the configuration, and provides useful features as high availability, automated backup, user management, and more.\n\n\n\n\n## Concepts\n\nRefer to our [dedicated concepts page](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/concepts/) to find definitions of the different terms referring to Managed Database for PostgreSQL and MySQL.\n\n\n\n\n## Quickstart\n\n1. Configure your environment variables.\n \n This is an optional step that seeks to simplify your usage of the APIs.\n \n\n ```bash\n export SCW_ACCESS_KEY=\"\"\n export SCW_SECRET_KEY=\"\"\n export SCW_REGION=\"\"\n ```\n2. Edit the POST request payload you will use to create your Database Instance. Replace the parameters in the following example:\n ```json\n '{\n \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\",\n \"name\": \"myDB\",\n \"engine\": \"PostgreSQL-15\",\n \"tags\": [\"donnerstag\"],\n \"is_ha_cluster\": true,\n \"node_type\": \"db-pro2-xxs\",\n \"disable_backup\": false,\n \"user_name\": \"my_initial_user\",\n \"password\": \"thiZ_is_v0ry_s3cret\",\n \"volume_type\": \"sbs_5k\",\n \"volume_size\": \"30000000000\"\n }'\n ```\n\n | Parameter | Description |\n | :--------------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n | `project_id` | The ID of the Project you want to create your Database Instance in. To find your Project ID you can **[list the projects](/api/account/project-api/#path-projects-list-all-projects-of-an-organization)** or consult the **[Scaleway console](https://console.scaleway.com/project/settings)**. |\n | `engine` | **REQUIRED** Version ID of the database engine. To check the list of available engines you can use the following endpoint: `https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/database-engines` |\n | `name` | Name of the Database Instance |\n | `node_type` | **REQUIRED** The node type. To check the list of available node types you can use the following endpoint: `https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/node-types` |\n | `is_ha_cluster` | **BOOLEAN** Defines whether High Availability is enabled for the Database Instance |\n | `disable_backup` | **BOOLEAN** Defines whether automated backups are disabled for the Database Instance |\n | `tags` | The list of tags `[\"tag1\", \"tag2\", ...]` that will be associated with the Database Instance. Tags can be appended to the query of the [List Database Instances](#path-database-instances-list-database-instances) call to show results for only the Database Instances using a specific tag. You can also combine tags to list Database Instances that possess all the appended tags. |\n | `user_name` | **REQUIRED** Identifier of the default user, which is created concurrently with the Database Instance |\n | `password` | **REQUIRED** Password for the default user |\n | `volume_type` | Type of volume where data is stored. You can specify either local volume (`lssd`) or block volume (`bssd`, `sbs_5k` or `sbs_15k`). The default value is `lssd` |\n | `volume_size` | Volume size when volume_type is `bssd`, `sbs_5k` or `sbs_15k`. The value should be expressed in bytes. For example 30GB is expressed as 30000000000 |\n3. Create a Database Instance by running the following command. Make sure you include the payload you edited in the previous step.\n ```bash\n curl -X POST \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"Content-Type: application/json\" \\\n https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/instances \\\n -d '{\n \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\",\n \"name\": \"myDB\",\n \"engine\": \"PostgreSQL-15\",\n \"tags\": [\"donnerstag\"],\n \"is_ha_cluster\": true,\n \"node_type\": \"db-pro2-xxs\",\n \"disable_backup\": false,\n \"user_name\": \"my_initial_user\",\n \"password\": \"thiZ_is_v0ry_s3cret\",\n \"volume_type\": \"sbs_5k\",\n \"volume_size\": \"30000000000\"\n }'\n ```\n4. List your Database Instances.\n ```bash\n curl -X GET \\\n -H \"Content-Type: application/json\" \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/instances\n ```\n\n You should get a response like the following:\n\n \n This is a response example, the UUIDs and IP address displayed are not real.\n \n\n ```json\n {\n \"id\": \"f5122f66-fb50-4cef-aa02-487ef4fc1af0\",\n \"name\": \"myDB\",\n \"organization_id\": \"895693aa-3915-4896-8761-c2923b008be7\",\n \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\",\n \"status\": \"ready\",\n \"engine\": \"PostgreSQL-15\",\n \"endpoint\": {\n \"ip\": \"198.51.100.0\",\n \"port\": 22245,\n \"name\": null\n },\n \"tags\": [\n \"donnerstag\"\n ],\n \"settings\": [],\n \"backup_schedule\": {\n \"frequency\": 24,\n \"retention\": 7,\n \"disabled\": true\n },\n \"is_ha_cluster\": true,\n \"read_replicas\": [],\n \"node_type\": \"db-pro2-xxs\",\n \"volume\": {\n \"type\": \"sbs_5k\",\n \"size\": 30000000000\n }\n \"created_at\": \"2019-04-19T16:24:52.591417Z\",\n \"region\": \"fr-par\"\n }\n ```\n5. Retrieve your Database Instance IP and port from the response.\n \n In the example above, the IP and port are `198.51.100.0` and `22245`, respectively.\n \n6. Connect to your Database Instance with the database client of the engine you selected.\n For MySQL, run the following command:\n ```bash\n mysql -h --port -p -u \n ```\n\n For PostgreSQL, run:\n ```bash\n psql -h -p -U -d rdb\n ```\n\n For the recurring example, the command would look like:\n\n ```bash\n psql -h 198.51.100.0 -p 22245 -U my_initial_user -d rdb\n ```\n7. Enter the database password that you defined upon creation.\n\nYou are now connected to your Managed Database.\n\n\n\nTo perform the following steps, you must first ensure that:\n - you have an account and are logged into the [Scaleway console](https://console.scaleway.com/organization)\n - you have created an [API key](https://www.scaleway.com/en/docs/iam/how-to/create-api-keys/) and that the API key has sufficient [IAM permissions](https://www.scaleway.com/en/docs/iam/reference-content/permission-sets/) to perform the actions described on this page.\n - you have [installed `curl`](https://curl.se/download.html)\n\n\n\n## Technical Information\n\n### Regions\n\nScaleway's infrastructure is spread across different [regions and Availability Zones](https://www.scaleway.com/en/docs/account/reference-content/products-availability/).\n\nManaged Database for PostgreSQL and MySQL is available in the Paris, Amsterdam and Warsaw regions, which are represented by the following path parameters:\n\n- `fr-par`\n- `nl-ams`\n- `pl-waw`\n\n### PostgreSQL specifications\n\n#### Versions\n\nScaleway Database for PostgreSQL supports PostgreSQL versions 11, 12, 13, 14 and 15.\n\n#### System\n\nDifferent modules are available for installation, including TimescaleDB and PostGIS. Refer to the [Managed Database for PostgreSQL and MySQL FAQ page](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/faq/#which-postgresql-extensions-are-available) for an extensive list of PostgreSQL extensions.\n\n#### Database Management\n\nYou can create logical databases through the Scaleway console, the Scaleway APIs or SQL.\n\n- databases created using the Scaleway console or the API are owned by an internal system user. These are called \"managed databases\".\n- databases created using SQL will be owned by the creator. These are called \"unmanaged databases\".\n\n### MySQL specifications\n\n#### Versions\n\nScaleway Database for MySQL supports MySQL 8.\n\n#### System\n\n- only the [InnoDB engine](https://dev.mysql.com/doc/refman/8.0/en/innodb-storage-engine.html) is supported\n- the [Global Transaction Identifier (GTID)](https://dev.mysql.com/doc/refman/8.0/en/replication-gtids-concepts.html) is enabled.\n- [`mysql_native_password`](https://dev.mysql.com/doc/refman/8.0/en/native-pluggable-authentication.html) (default) and [`caching_sha2_password`](https://dev.mysql.com/doc/refman/8.0/en/caching-sha2-pluggable-authentication.html) authentication are supported.\n\n#### User Management\n\n- users with an `admin` role have access to all logical databases and can create new ones.\n- users created via the API are authenticated using the default authentication plugin, which can be changed in the settings.\n\n## Technical Limitations\n\n### PostgreSQL\n\n#### User Management\n\n- users with an `admin` role have `CREATEROLE` and `CREATEDB` privileges.\n- users do NOT have `SUPERUSER` nor `REPLICATION` privileges.\n- permission management through the Scaleway console or API is only possible for the \"managed databases\".\n\n#### Backup and restoration\n\nDatabases that have been backed up and then restored retain the user permission settings in use at the time of backup. If you delete users after backup and then restore your backup in the same database, or if you restore a backup to a different database with different or no users, the permissions configured for them continue to exist, but with no associated owner. This error will put a stop to the restoration process.\n\nTo avoid this issue, we recommend you re-create the users you deleted. In the occasion you restore the backup to a new database, you must create new users with the same names.\n\n## Going Further\n\nFor more information about Managed Database for PostgreSQL and MySQL, you can check out the following pages:\n\n* [Managed Database for PostgreSQL and MySQL Documentation](https://www.scaleway.com/en/docs/managed-databases/postgresql-and-mysql/)\n* [Managed Database for PostgreSQL and MySQL FAQ](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/faq/)\n* [Scaleway Slack Community](https://scaleway-community.slack.com/) join the #database channel\n* [Contact our support team](https://console.scaleway.com/support/tickets)\n\n### How to migrate a database\n\nIf you wish to migrate existing databases to a Managed Database for PostgreSQL or MySQL, you can refer to the [Migrating existing databases to a Database Instance](https://www.scaleway.com/en/docs/tutorials/migrate-databases-instance/) tutorial page.\n\n### Troubleshoooting\n\n#### Disk full status\n\nIf your Database Instance uses local storage, your local volume might eventually approach full capacity and shift to `disk_full` mode. This mode grants you enough space to either [upgrade your node type](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/how-to/upgrade-version/#how-to-change-the-node-type) or [clear out space in your volume](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/troubleshooting/disk-full/)." version: v1 servers: - url: https://api.scaleway.com tags: - name: Triggers description: 'A trigger is a way to invoke a container based on specific events, such as a periodic schedule or a message arriving in a queue. When the event occurs, the trigger invokes the container, passing relevant information about the event to it. ' paths: /containers/v1/regions/{region}/triggers: get: tags: - Triggers operationId: ListTriggers summary: List all triggers the caller can access (read permission). description: 'By default, the triggers listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. Additional parameters can be set in the query to filter, such as `organization_id`, `project_id`, `namespace_id`, or `container_id`.' parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - nl-ams - pl-waw - in: query name: page schema: type: integer format: int32 - in: query name: page_size schema: type: integer format: uint32 - in: query name: order_by schema: $ref: '#/components/schemas/scaleway.containers.v1.ListTriggersRequest.OrderBy' - in: query name: organization_id schema: type: string - in: query name: project_id schema: type: string - in: query name: namespace_id schema: type: string - in: query name: container_id schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.containers.v1.ListTriggersResponse' security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/containers/v1/regions/{region}/triggers\"" - lang: HTTPie source: "http GET \"https://api.scaleway.com/containers/v1/regions/{region}/triggers\" \\\n X-Auth-Token:$SCW_SECRET_KEY" post: tags: - Triggers operationId: CreateTrigger summary: Create a new trigger for the container with the specified ID. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - nl-ams - pl-waw responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.containers.v1.Trigger' requestBody: required: true content: application/json: schema: type: object properties: container_id: type: string description: ID of the container to trigger. name: type: string description: Name of the trigger. description: type: string description: Description of the trigger. tags: type: array description: Tags of the trigger. items: type: string destination_config: type: object description: Configuration of the destination to trigger. properties: http_path: type: string description: The HTTP path to send the request to (e.g., "/my-webhook-endpoint"). http_method: type: string description: The HTTP method to use when sending the request (e.g., get, post, put, patch, delete). Must be specified as lowercase. enum: - unknown_http_method - get - post - put - patch - delete default: unknown_http_method required: - http_path - http_method x-properties-order: - http_path - http_method cron_config: type: object description: Configuration for a cron source. properties: schedule: type: string description: UNIX cron schedule to run job (e.g., "* * * * *"). timezone: type: string description: Timezone for the cron schedule, in tz database format (e.g., "Europe/Paris"). body: type: string description: Body to send to the container when the trigger is invoked. headers: type: object description: Additional headers to send to the container when the trigger is invoked. properties: : type: string description: Additional headers to send to the container when the trigger is invoked. additionalProperties: true nullable: true required: - schedule - timezone x-properties-order: - schedule - timezone - body - headers x-one-of: source_config sqs_config: type: object description: Configuration for an SQS queue source. properties: region: type: string description: The region where the SQS queue is hosted (e.g., "fr-par", "nl-ams"). endpoint: type: string description: Endpoint URL to use to access SQS (e.g., "https://sqs.mnq.fr-par.scaleway.com"). access_key_id: type: string description: The access key for accessing the SQS queue. secret_access_key: type: string description: The secret key for accessing the SQS queue. queue_url: type: string description: The URL of the SQS queue to monitor for messages. nullable: true required: - region - endpoint - access_key_id - secret_access_key - queue_url x-properties-order: - region - endpoint - access_key_id - secret_access_key - queue_url x-one-of: source_config nats_config: type: object description: Configuration for a NATS source. properties: server_urls: type: array description: The URLs of the NATS server (e.g., "nats://nats.mnq.fr-par.scaleway.com:4222"). items: type: string subject: type: string description: NATS subject to subscribe to (e.g., "my-subject"). credentials_file_content: type: string description: 'The content of the NATS credentials file. The credentials from this file will be used to authenticate with the NATS server and subscribe to the specified subject.' nullable: true required: - server_urls - subject - credentials_file_content x-properties-order: - server_urls - subject - credentials_file_content x-one-of: source_config required: - container_id - name x-properties-order: - container_id - name - description - tags - destination_config - cron_config - sqs_config - nats_config security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X POST \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"container_id\":\"string\",\"name\":\"string\"}' \\\n \"https://api.scaleway.com/containers/v1/regions/{region}/triggers\"" - lang: HTTPie source: "http POST \"https://api.scaleway.com/containers/v1/regions/{region}/triggers\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n container_id=\"string\" \\\n name=\"string\"" /containers/v1/regions/{region}/triggers/{trigger_id}: get: tags: - Triggers operationId: GetTrigger summary: Get the trigger associated with the specified ID. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - nl-ams - pl-waw - in: path name: trigger_id required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.containers.v1.Trigger' security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/containers/v1/regions/{region}/triggers/{trigger_id}\"" - lang: HTTPie source: "http GET \"https://api.scaleway.com/containers/v1/regions/{region}/triggers/{trigger_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY" patch: tags: - Triggers operationId: UpdateTrigger summary: Update the trigger associated with the specified ID. description: 'When updating a trigger, you cannot specify a different source type than the one already set. Only fields present in the request are updated; others are left untouched.' parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - nl-ams - pl-waw - in: path name: trigger_id description: ID of the trigger to update. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.containers.v1.Trigger' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: Name of the trigger. description: type: string description: Description of the trigger. tags: type: array description: Tags of the trigger. nullable: true items: type: string destination_config: type: object description: Configuration of the destination to trigger. properties: http_path: type: string description: The HTTP path to send the request to (e.g., "/my-webhook-endpoint"). http_method: type: string description: The HTTP method to use when sending the request (e.g., get, post, put, patch, delete). Must be specified as lowercase. enum: - unknown_http_method - get - post - put - patch - delete default: unknown_http_method x-properties-order: - http_path - http_method cron_config: type: object description: Configuration for a cron source. properties: schedule: type: string description: UNIX cron schedule to run job (e.g., "* * * * *"). timezone: type: string description: Timezone for the cron schedule, in tz database format (e.g., "Europe/Paris"). body: type: string description: Body to send to the container when the trigger is invoked. headers: type: object description: Additional headers to send to the container when the trigger is invoked. properties: : type: string nullable: true nullable: true x-properties-order: - schedule - timezone - body - headers x-one-of: source_config sqs_config: type: object description: Configuration for an SQS queue source. properties: region: type: string description: The region where the SQS queue is hosted (e.g., "fr-par", "nl-ams"). endpoint: type: string description: Endpoint URL to use to access SQS (e.g., "https://sqs.mnq.fr-par.scaleway.com"). access_key_id: type: string description: The access key for accessing the SQS queue. secret_access_key: type: string description: The secret key for accessing the SQS queue. queue_url: type: string description: The URL of the SQS queue to monitor for messages. nullable: true x-properties-order: - region - endpoint - access_key_id - secret_access_key - queue_url x-one-of: source_config nats_config: type: object description: Configuration for a NATS source. properties: server_urls: type: array description: The URLs of the NATS server (e.g., "nats://nats.mnq.fr-par.scaleway.com:4222"). nullable: true items: type: string subject: type: string description: NATS subject to subscribe to (e.g., "my-subject"). credentials_file_content: type: string description: 'The content of the NATS credentials file. The credentials from this file will be used to authenticate with the NATS server and subscribe to the specified subject.' nullable: true x-properties-order: - server_urls - subject - credentials_file_content x-one-of: source_config x-properties-order: - name - description - tags - destination_config - cron_config - sqs_config - nats_config security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X PATCH \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{}' \\\n \"https://api.scaleway.com/containers/v1/regions/{region}/triggers/{trigger_id}\"" - lang: HTTPie source: "http PATCH \"https://api.scaleway.com/containers/v1/regions/{region}/triggers/{trigger_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY" delete: tags: - Triggers operationId: DeleteTrigger summary: Delete the trigger associated with the specified ID. description: This action **cannot** be undone. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - nl-ams - pl-waw - in: path name: trigger_id description: ID of the trigger to delete. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.containers.v1.Trigger' security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X DELETE \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/containers/v1/regions/{region}/triggers/{trigger_id}\"" - lang: HTTPie source: "http DELETE \"https://api.scaleway.com/containers/v1/regions/{region}/triggers/{trigger_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY" /functions/v1beta1/regions/{region}/triggers: get: tags: - Triggers operationId: ListTriggers summary: List all triggers description: List all triggers belonging to a specified Organization or Project. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - nl-ams - pl-waw - in: query name: page description: Page number to return. schema: type: integer format: int32 - in: query name: page_size description: Maximum number of triggers to return per page. schema: type: integer format: uint32 - in: query name: order_by description: Order in which to return results. schema: type: string enum: - created_at_asc - created_at_desc x-enum-descriptions: values: created_at_asc: Order by creation date ascending created_at_desc: Order by creation date descending default: created_at_asc responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.functions.v1beta1.ListTriggersResponse' security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/functions/v1beta1/regions/{region}/triggers\"" - lang: HTTPie source: "http GET \"https://api.scaleway.com/functions/v1beta1/regions/{region}/triggers\" \\\n X-Auth-Token:$SCW_SECRET_KEY" post: tags: - Triggers operationId: CreateTrigger summary: Create a trigger description: Create a new trigger for a specified function. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - nl-ams - pl-waw responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.functions.v1beta1.Trigger' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: Name of the trigger. function_id: type: string description: ID of the function to trigger. description: type: string description: Description of the trigger. nullable: true scw_sqs_config: type: object description: Configuration for a Scaleway Messaging and Queuing SQS queue. properties: queue: type: string description: Name of the SQS queue the trigger should listen to. mnq_project_id: type: string description: 'ID of the Messaging and Queuing project. You must have activated SQS on this project.' mnq_region: type: string description: 'Region in which the Messaging and Queuing project is activated. Currently, only the `fr-par` and `nl-ams` regions are available.' nullable: true required: - queue - mnq_project_id - mnq_region x-properties-order: - queue - mnq_project_id - mnq_region x-one-of: config scw_nats_config: type: object description: Configuration for a Scaleway Messaging and Queuing NATS subject. properties: subject: type: string description: Name of the NATS subject the trigger should listen to. mnq_nats_account_id: type: string description: ID of the Messaging and Queuing NATS account. mnq_project_id: type: string description: ID of the Messaging and Queuing project. mnq_region: type: string description: 'Region in which the Messaging and Queuing project is activated. Currently, only the `fr-par` and `nl-ams` regions are available.' nullable: true required: - subject - mnq_nats_account_id - mnq_region x-properties-order: - subject - mnq_nats_account_id - mnq_project_id - mnq_region x-one-of: config required: - name - function_id x-properties-order: - name - function_id - description - scw_sqs_config - scw_nats_config security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X POST \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"function_id\":\"string\",\"name\":\"string\"}' \\\n \"https://api.scaleway.com/functions/v1beta1/regions/{region}/triggers\"" - lang: HTTPie source: "http POST \"https://api.scaleway.com/functions/v1beta1/regions/{region}/triggers\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n function_id=\"string\" \\\n name=\"string\"" /functions/v1beta1/regions/{region}/triggers/{trigger_id}: get: tags: - Triggers operationId: GetTrigger summary: Get a trigger description: Get a trigger with a specified ID. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - nl-ams - pl-waw - in: path name: trigger_id description: ID of the trigger to get. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.functions.v1beta1.Trigger' security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/functions/v1beta1/regions/{region}/triggers/{trigger_id}\"" - lang: HTTPie source: "http GET \"https://api.scaleway.com/functions/v1beta1/regions/{region}/triggers/{trigger_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY" patch: tags: - Triggers operationId: UpdateTrigger summary: Update a trigger description: Update a trigger with a specified ID. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - nl-ams - pl-waw - in: path name: trigger_id description: ID of the trigger to update. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.functions.v1beta1.Trigger' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: Name of the trigger. nullable: true description: type: string description: Description of the trigger. nullable: true x-properties-order: - name - description security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X PATCH \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{}' \\\n \"https://api.scaleway.com/functions/v1beta1/regions/{region}/triggers/{trigger_id}\"" - lang: HTTPie source: "http PATCH \"https://api.scaleway.com/functions/v1beta1/regions/{region}/triggers/{trigger_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY" delete: tags: - Triggers operationId: DeleteTrigger summary: Delete a trigger description: Delete a trigger with a specified ID. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - nl-ams - pl-waw - in: path name: trigger_id description: ID of the trigger to delete. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.functions.v1beta1.Trigger' security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X DELETE \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/functions/v1beta1/regions/{region}/triggers/{trigger_id}\"" - lang: HTTPie source: "http DELETE \"https://api.scaleway.com/functions/v1beta1/regions/{region}/triggers/{trigger_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY" components: schemas: scaleway.functions.v1beta1.Trigger: type: object properties: id: type: string description: ID of the trigger. name: type: string description: Name of the trigger. description: type: string description: Description of the trigger. function_id: type: string description: ID of the function to trigger. input_type: type: string description: Type of the input. enum: - unknown_input_type - sqs - scw_sqs - nats - scw_nats x-enum-descriptions: values: unknown_input_type: Unknown input type scw_sqs: Scaleway Messaging and Queuing SQS queue scw_nats: Scaleway Messaging and Queuing NATS subject default: unknown_input_type status: type: string description: Status of the trigger. enum: - unknown_status - ready - deleting - error - creating - pending x-enum-descriptions: values: unknown_status: Unknown status ready: Ready status deleting: Deleting status error: Error status creating: Creating status pending: Pending status default: unknown_status error_message: type: string description: Error message of the trigger. nullable: true scw_sqs_config: type: object description: Configuration for a Scaleway Messaging and Queuing SQS queue. properties: queue: type: string description: Name of the SQS queue the trigger listens to. mnq_project_id: type: string description: ID of the Messaging and Queuing project. mnq_region: type: string description: 'Region in which the Messaging and Queuing project is activated. Currently, only the `fr-par` and `nl-ams` regions are available.' mnq_credential_id: type: string description: ID of the Messaging and Queuing credentials used to read from the SQS queue. nullable: true nullable: true x-properties-order: - queue - mnq_project_id - mnq_region - mnq_credential_id x-one-of: config scw_nats_config: type: object description: Configuration for a Scaleway Messaging and Queuing NATS subject. properties: subject: type: string description: Name of the NATS subject the trigger listens to. mnq_nats_account_id: type: string description: ID of the Messaging and Queuing NATS account. mnq_project_id: type: string description: ID of the Messaging and Queuing project. mnq_region: type: string description: 'Region in which the Messaging and Queuing project is activated. Currently, only the `fr-par` and `nl-ams` regions are available.' mnq_credential_id: type: string description: ID of the Messaging and Queuing credentials used to subscribe to the NATS subject. nullable: true nullable: true x-properties-order: - subject - mnq_nats_account_id - mnq_project_id - mnq_region - mnq_credential_id x-one-of: config x-properties-order: - id - name - description - function_id - input_type - status - error_message - scw_sqs_config - scw_nats_config scaleway.functions.v1beta1.ListTriggersResponse: type: object properties: total_count: type: integer description: Total count of existing triggers (matching any filters specified). format: uint32 triggers: type: array description: Triggers on this page. items: $ref: '#/components/schemas/scaleway.functions.v1beta1.Trigger' x-properties-order: - total_count - triggers scaleway.containers.v1.Trigger: type: object properties: id: type: string description: Trigger unique ID. (UUID format) example: 6170692e-7363-616c-6577-61792e636f6d name: type: string description: Name of the trigger. description: type: string description: Description of the trigger. tags: type: array description: Tags of the trigger. items: type: string status: type: string description: Trigger status. enum: - unknown_status - ready - deleting - error - updating - creating - locking - locked - upgrading x-enum-descriptions: values: unknown_status: Unknown status ready: Ready status deleting: Deleting status error: Error status updating: Updating status. Resource is being redeployed to match the desired configuration creating: Creating status. Resource is being created locking: Locking status locked: Locked status. Resource cannot be modified upgrading: Upgrading status. Resource is being upgraded as part of a planned maintenance. No downtime is expected default: unknown_status error_message: type: string description: Trigger last error message. container_id: type: string description: ID of the container to trigger. (UUID format) example: 6170692e-7363-616c-6577-61792e636f6d destination_config: type: object description: Configuration of the destination to trigger. properties: http_path: type: string description: The HTTP path to send the request to (e.g., "/my-webhook-endpoint"). http_method: type: string description: The HTTP method to use when sending the request (e.g., get, post, put, patch, delete). Must be specified as lowercase. enum: - unknown_http_method - get - post - put - patch - delete default: unknown_http_method x-properties-order: - http_path - http_method source_type: type: string description: Type of source that will trigger the container. enum: - unknown_source_type - cron - sqs - nats x-enum-descriptions: values: unknown_source_type: Unknown source type cron: Cron source type sqs: SQS source type nats: NATS source type default: unknown_source_type cron_config: type: object description: Configuration for a cron source. properties: schedule: type: string description: UNIX cron schedule to run job (e.g., "* * * * *"). timezone: type: string description: Timezone for the cron schedule, in tz database format (e.g., "Europe/Paris"). body: type: string description: Body to send to the container when the trigger is invoked. headers: type: object description: Additional headers to send to the container when the trigger is invoked. properties: : type: string description: Additional headers to send to the container when the trigger is invoked. additionalProperties: true nullable: true x-properties-order: - schedule - timezone - body - headers x-one-of: source_config sqs_config: type: object description: Configuration for an SQS queue source. properties: region: type: string description: The region where the SQS queue is hosted (e.g., "fr-par", "nl-ams"). endpoint: type: string description: Endpoint URL to use to access SQS (e.g., "https://sqs.mnq.fr-par.scaleway.com"). access_key_id: type: string description: The access key for accessing the SQS queue. queue_url: type: string description: The URL of the SQS queue to monitor for messages. nullable: true x-properties-order: - region - endpoint - access_key_id - queue_url x-one-of: source_config nats_config: type: object description: Configuration for a NATS source. properties: server_urls: type: array description: The URLs of the NATS servers (e.g., "nats://nats.mnq.fr-par.scaleway.com:4222"). items: type: string subject: type: string description: NATS subject to subscribe to (e.g., "my-subject"). nullable: true x-properties-order: - server_urls - subject x-one-of: source_config created_at: type: string description: Trigger creation date. (RFC 3339 format) format: date-time example: '2022-03-22T12:34:56.123456Z' nullable: true updated_at: type: string description: Trigger last update date. (RFC 3339 format) format: date-time example: '2022-03-22T12:34:56.123456Z' nullable: true x-properties-order: - id - name - description - tags - status - error_message - container_id - destination_config - source_type - cron_config - sqs_config - nats_config - created_at - updated_at scaleway.containers.v1.ListTriggersResponse: type: object properties: triggers: type: array items: $ref: '#/components/schemas/scaleway.containers.v1.Trigger' total_count: type: integer format: uint64 x-properties-order: - triggers - total_count scaleway.containers.v1.ListTriggersRequest.OrderBy: type: string enum: - created_at_asc - created_at_desc - name_asc - name_desc default: created_at_asc securitySchemes: scaleway: in: header name: X-Auth-Token type: apiKey