STACKIT

STACKIT PostgreSQL Flex API

This is the documentation for the STACKIT Postgres Flex service

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the documentation for the STACKIT Postgres Flex service

Endpoints 27

  • GETGet Flavors/v3/projects/:projectId/regions/:region/flavorsGet all available flavors for a project.
  • GETList Instances/v3/projects/:projectId/regions/:region/instancesList all available instances for your project.
  • POSTCreate Instance/v3/projects/:projectId/regions/:region/instancesCreate a new instance of a postgres database instance.
  • GETGet Specific Instance/v3/projects/:projectId/regions/:region/instances/:instanceIdGet information about a specific available instance
  • PUTUpdate Instance/v3/projects/:projectId/regions/:region/instances/:instanceIdUpdates an available instance of a postgres database
  • DELETEDelete Instance/v3/projects/:projectId/regions/:region/instances/:instanceIdDelete an available postgres instance.
  • PATCHUpdate Instance Partially/v3/projects/:projectId/regions/:region/instances/:instanceIdUpdate an available instance of a postgres database. No fields are required.
  • GETList Backups/v3/projects/:projectId/regions/:region/instances/:instanceId/backupsList all backups which are available for a specific instance.
  • GETGet specific backup/v3/projects/:projectId/regions/:region/instances/:instanceId/backups/:backupIdGet information about a specific backup for an instance.
  • POSTClone Instance/v3/projects/:projectId/regions/:region/instances/:instanceId/cloneClone Instance
  • GETGet Collations for an Instance/v3/projects/:projectId/regions/:region/instances/:instanceId/collationsGet available collations for an instance
  • GETList Databases/v3/projects/:projectId/regions/:region/instances/:instanceId/databasesList available databases for an instance.
  • POSTCreate Database/v3/projects/:projectId/regions/:region/instances/:instanceId/databasesCreate database for a user. Note: The name of a valid user must be provided in the 'options' map field using the key 'owner'
  • GETGet Specific Database/v3/projects/:projectId/regions/:region/instances/:instanceId/databases/:databaseIdGet information about a specific database in an instance.
  • PUTUpdate Database/v3/projects/:projectId/regions/:region/instances/:instanceId/databases/:databaseIdUpdate a database in an instance.
  • DELETEDelete Database/v3/projects/:projectId/regions/:region/instances/:instanceId/databases/:databaseIdDelete database for an instance.
  • PATCHUpdate Database partially/v3/projects/:projectId/regions/:region/instances/:instanceId/databases/:databaseIdUpdate a database partially in an instance.
  • POSTToggle Instance Protection/v3/projects/:projectId/regions/:region/instances/:instanceId/protectionsToggle the deletion protection for an instance.
  • GETList Roles/v3/projects/:projectId/regions/:region/instances/:instanceId/rolesList available roles for an instance.
  • GETList Users/v3/projects/:projectId/regions/:region/instances/:instanceId/usersList available users for an instance.
  • POSTCreate User/v3/projects/:projectId/regions/:region/instances/:instanceId/usersCreate user for an instance.
  • GETGet User/v3/projects/:projectId/regions/:region/instances/:instanceId/users/:userIdGet a specific available user for an instance.
  • PUTUpdate User/v3/projects/:projectId/regions/:region/instances/:instanceId/users/:userIdUpdate user for an instance.
  • DELETEDelete User/v3/projects/:projectId/regions/:region/instances/:instanceId/users/:userIdDelete a user from a specific instance.
  • PATCHUpdate User Partially/v3/projects/:projectId/regions/:region/instances/:instanceId/users/:userIdUpdate a user partially for an instance.
  • POSTReset User/v3/projects/:projectId/regions/:region/instances/:instanceId/users/:userId/resetReset a user from a specific instance.
  • GETGet Versions/v3/projects/:projectId/regions/:region/versionsGet available postgres versions for the project.

API details

Base URL
https://postgres-flex-service.api.stackit.cloud
Authentication
None declared in the description
Operations
27 operations on 15 pathsGET 12POST 6PUT 3PATCH 3DELETE 3
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 3.0.0

How to test the STACKIT PostgreSQL Flex API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the STACKIT PostgreSQL Flex API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get Flavors” (GET /v3/projects/:projectId/regions/:region/flavors), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the STACKIT PostgreSQL Flex API?

This is the documentation for the STACKIT Postgres Flex service It is listed under Developer tools and has 27 endpoints.

Who publishes the STACKIT PostgreSQL Flex API?

It is listed from STACKIT's public API description (an OpenAPI document), not published by STACKIT on Swastik Codes. Anyone who controls stackit.cloud can claim the profile by adding a DNS TXT record.

What is the base URL of the STACKIT PostgreSQL Flex API?

Requests go to https://postgres-flex-service.api.stackit.cloud. Endpoint paths are added to this base URL.

How do I authenticate with the STACKIT PostgreSQL Flex API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the STACKIT PostgreSQL Flex API have?

27 operations on 15 paths (12 GET, 6 POST, 3 PUT, 3 PATCH, 3 DELETE).

Is forking the STACKIT PostgreSQL Flex API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.