Scaleway

Scaleway Endpoints API

A point of connection to a Database Instance. The endpoint is associated with an IPv4 address and a port. It contains the information about whether the endpoint is read-write or not. The endpoints always point to the main node of a Database Instance. All endpoints have TLS enabled. You can use TLS to make your data and your passwords unreadable in transit to anyone but you. For added security, you can set up ACL rules to restrict access to your endpoint to a set of trusted hosts or networks of your choice. Load Balancers are used to forward traffic to the right node based on the node state (active/hot standby). The Load Balancers' configuration is set to cut off inactive connections if no TCP traffic is sent within a 6-hour timeframe. We recommend using connection pooling on the application side to renew database connections regularly.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 4

GET /rdb/v1/regions/{region}/endpoints/{endpoint_id} Get a Database Instance endpoint #
DELETE /rdb/v1/regions/{region}/endpoints/{endpoint_id} Delete a Database Instance endpoint #
POST /rdb/v1/regions/{region}/endpoints/{endpoint_id}/migrate Migrate an existing instance endpoint to another instance #
POST /rdb/v1/regions/{region}/instances/{instance_id}/endpoints Create a new Database Instance endpoint #

Documentation

📖
Documentation
https://www.scaleway.com/en/developers/api/instances/
📖
Documentation
https://www.scaleway.com/en/developers/api/kubernetes/
📖
Documentation
https://www.scaleway.com/en/developers/api/iam/
📖
Documentation
https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/
📖
Documentation
https://www.scaleway.com/en/developers/api/managed-databases-for-postgresql-and-mysql/
📖
Documentation
https://www.scaleway.com/en/developers/api/vpc/
📖
Documentation
https://www.scaleway.com/en/developers/api/serverless-containers/
📖
Documentation
https://www.scaleway.com/en/developers/api/serverless-functions/
📖
Documentation
https://www.scaleway.com/en/developers/api/secret-manager/
📖
Documentation
https://www.scaleway.com/en/developers/api/transactional-email/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/scaleway/refs/heads/main/openapi/scaleway-endpoints-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/scaleway-endpoints-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

scaleway-endpoints-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Managed Database for PostgreSQL and MySQL Endpoints API
  description: Managed Database for PostgreSQL and MySQL provides fully-managed relational Database Instances, with MySQL or PostgreSQL as database engines.
  version: v1
servers:
- url: https://api.scaleway.com
tags:
- name: Endpoints
  description: A point of connection to a Database Instance.
paths:
  /rdb/v1/regions/{region}/endpoints/{endpoint_id}:
    get:
      tags:
      - Endpoints
      operationId: GetEndpoint
      summary: Get a Database Instance endpoint
      description: Retrieve information about a Database Instance endpoint. Full details about the endpoint, like `ip`, `port`, `private_network` and `load_balancer` specifications are returned in the response.
      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: endpoint_id
        description: UUID of the endpoint you want to get.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scaleway.rdb.v1.Endpoint'
      security:
      - scaleway: []
      x-codeSamples:
      - lang: cURL
        source: "curl -X GET \\\n  -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n  \"https://api.scaleway.com/rdb/v1/regions/{region}/endpoints/{endpoint_id}\""
      - lang: HTTPie
        source: "http GET \"https://api.scaleway.com/rdb/v1/regions/{region}/endpoints/{endpoint_id}\" \\\n  X-Auth-Token:$SCW_SECRET_KEY"
    delete:
      tags:
      - Endpoints
      operationId: DeleteEndpoint
      summary: Delete a Database Instance endpoint
      description: Delete the endpoint of a Database Instance. You must specify the `region` and `endpoint_id` parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint.
      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: endpoint_id
        description: 'UUID of the endpoint you want to delete.

          This endpoint can also be used to delete a Read Replica endpoint.'
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      security:
      - scaleway: []
      x-codeSamples:
      - lang: cURL
        source: "curl -X DELETE \\\n  -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n  \"https://api.scaleway.com/rdb/v1/regions/{region}/endpoints/{endpoint_id}\""
      - lang: HTTPie
        source: "http DELETE \"https://api.scaleway.com/rdb/v1/regions/{region}/endpoints/{endpoint_id}\" \\\n  X-Auth-Token:$SCW_SECRET_KEY"
  /rdb/v1/regions/{region}/endpoints/{endpoint_id}/migrate:
    post:
      tags:
      - Endpoints
      operationId: MigrateEndpoint
      summary: Migrate an existing instance endpoint to another instance
      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: endpoint_id
        description: UUID of the endpoint you want to migrate.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scaleway.rdb.v1.Endpoint'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                instance_id:
                  type: string
                  description: UUID of the instance you want to attach the endpoint to.
              required:
              - instance_id
              x-properties-order:
              - instance_id
      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 '{\"instance_id\":\"string\"}' \\\n  \"https://api.scaleway.com/rdb/v1/regions/{region}/endpoints/{endpoint_id}/migrate\""
      - lang: HTTPie
        source: "http POST \"https://api.scaleway.com/rdb/v1/regions/{region}/endpoints/{endpoint_id}/migrate\" \\\n  X-Auth-Token:$SCW_SECRET_KEY \\\n  instance_id=\"string\""
  /rdb/v1/regions/{region}/instances/{instance_id}/endpoints:
    post:
      tags:
      - Endpoints
      operationId: CreateEndpoint
      summary: Create a new Database Instance endpoint
      description: Create a new endpoint for a Database Instance. You can add `load_balancer` and `private_network` specifications to the body of the request.
      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: instance_id
        description: UUID of the Database Instance you to which you want to add an endpoint.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scaleway.rdb.v1.Endpoint'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                endpoint_spec:
                  type: object
                  description: Specification of the endpoint you want to create.
                  properties:
                    load_balancer:
                      type: object
                      description: Load balancer endpoint specifications. Public endpoint for Database Instance which is systematically present. One per RDB instance.
                      nullable: true
                      x-one-of: spec
                    private_network:
                      type: object
                      description: Private Network endpoint specifications. One maximum per Database Instance or Read Replica (a Database Instance and its Read Replica can have different Private Networks). Cannot be updated (has to be deleted and recreated).
                      properties:
                        private_network_id:
                          type: string
                          description: UUID of the Private Network to be connected to the Database Instance. (UUID format)
                          example: 6170692e-7363-616c-6577-61792e636f6d
                        service_ip:
                          type: string
                          description: Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations. (IP network)
                          example: 1.2.3.4/32
                          nullable: true
                          x-one-of: config
                        ipam_config:
                          type: object
                          description: Automated configuration of your Private Network endpoint with Scaleway IPAM service. One at the most per Database Instance or Read Replica (a Database Instance and its Read Replica can have different Private Networks). Cannot be updated (has to be deleted and recreated).
                          nullable: true
                          x-one-of: config
                      nullable: true
                      x-properties-order:
                      - private_network_id
                      - service_ip
                      - ipam_config
                      x-one-of: spec
                  x-properties-order:
                  - load_balancer
                  - private_network
              x-properties-order:
              - endpoint_spec
      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 '{}' \\\n  \"https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}/endpoints\""
      - lang: HTTPie
        source: "http POST \"https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}/endpoints\" \\\n  X-Auth-Token:$SCW_SECRET_KEY"
components:
  schemas:
    scaleway.rdb.v1.Endpoint:
      type: object
      properties:
        id:
          type: string
          description: UUID of the endpoint. (UUID format)
          example: 6170692e-7363-616c-6577-61792e636f6d
        ip:
          type: string
          description: IPv4 address of the endpoint. (IP address)
          example: 1.2.3.4
          nullable: true
          x-one-of: address
        port:
          type: integer
          description: TCP port of the endpoint.
          format: uint32
        name:
          type: string
          description: Name of the endpoint.
          nullable: true
        private_network:
          type: object
          description: Private Network details. One maximum per Database Instance or Read Replica (a Database Instance and its Read Replica can have different Private Networks). Cannot be updated (has to be deleted and recreated).
          properties:
            private_network_id:
              type: string
              description: UUID of the private network. (UUID format)
              example: 6170692e-7363-616c-6577-61792e636f6d
            service_ip:
              type: string
              description: CIDR notation of the endpoint IPv4 address. (IP network)
              example: 1.2.3.4/32
            zone:
              type: string
              description: Private network zone.
            provisioning_mode:
              type: string
              description: How endpoint ips are provisioned.
              enum:
              - static
              - ipam
              default: static
          nullable: true
          x-properties-order:
          - private_network_id
          - service_ip
          - zone
          - provisioning_mode
          x-one-of: details
        load_balancer:
          type: object
          description: Load balancer details. Public endpoint for Database Instance which is systematically present. One per Database Instance.
          nullable: true
          x-one-of: details
        direct_access:
          type: object
          description: Direct access details. Public endpoint reserved for Read Replicas. One per Read Replica.
          nullable: true
          x-one-of: details
        hostname:
          type: string
          description: Hostname of the endpoint.
          nullable: true
          x-one-of: address
      x-properties-order:
      - id
      - ip
      - port
      - name
      - private_network
      - load_balancer
      - direct_access
      - hostname
  securitySchemes:
    scaleway:
      in: header
      name: X-Auth-Token
      type: apiKey