Skip to content

DatabasesApi.md

Latest commit

 

History

History
368 lines (256 loc) · 13.6 KB

DatabasesApi.md

File metadata and controls

368 lines (256 loc) · 13.6 KB

ionoscloud_dbaas_postgres.DatabasesApi

All URIs are relative to https://api.ionos.com/databases/postgresql

Method HTTP request Description
databases_delete DELETE /clusters/{clusterId}/databases/{databasename} Delete database
databases_get GET /clusters/{clusterId}/databases/{databasename} Get database
databases_list GET /clusters/{clusterId}/databases List databases
databases_post POST /clusters/{clusterId}/databases Create a database

databases_delete

databases_delete(cluster_id, databasename)

Delete database

Deletes a single database

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (tokenAuth):
import ionoscloud_dbaas_postgres
from ionoscloud_dbaas_postgres.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.ionos.com/databases/postgresql
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud_dbaas_postgres.Configuration(
    host = "https://api.ionos.com/databases/postgresql"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = ionoscloud_dbaas_postgres.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ionoscloud_dbaas_postgres.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_dbaas_postgres.DatabasesApi(api_client)
    cluster_id = '498ae72f-411f-11eb-9d07-046c59cc737e' # str | The unique ID of the cluster.
    databasename = 'benjamindb' # str | The database name.

    try:
        # Delete database
        api_instance.databases_delete(cluster_id, databasename)
    except Exception as e:
        print("Exception when calling DatabasesApi->databases_delete: %s\n" % e)

Parameters

Name Type Description Notes
cluster_id str The unique ID of the cluster.
databasename str The database name.

Return type

void (empty response body)

Authorization

basicAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Successful response -
0 Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient permissions), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), 503 (maintenance) * Content-Type - application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

databases_get

DatabaseResource databases_get(cluster_id, databasename)

Get database

Retrieves a single database

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (tokenAuth):
import ionoscloud_dbaas_postgres
from ionoscloud_dbaas_postgres.models.database_resource import DatabaseResource
from ionoscloud_dbaas_postgres.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.ionos.com/databases/postgresql
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud_dbaas_postgres.Configuration(
    host = "https://api.ionos.com/databases/postgresql"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = ionoscloud_dbaas_postgres.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ionoscloud_dbaas_postgres.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_dbaas_postgres.DatabasesApi(api_client)
    cluster_id = '498ae72f-411f-11eb-9d07-046c59cc737e' # str | The unique ID of the cluster.
    databasename = 'benjamindb' # str | The database name.

    try:
        # Get database
        api_response = api_instance.databases_get(cluster_id, databasename)
        print("The response of DatabasesApi->databases_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DatabasesApi->databases_get: %s\n" % e)

Parameters

Name Type Description Notes
cluster_id str The unique ID of the cluster.
databasename str The database name.

Return type

DatabaseResource

Authorization

basicAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation. -
0 Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient permissions), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), 503 (maintenance) * Content-Type - application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

databases_list

DatabaseList databases_list(cluster_id, limit=limit, offset=offset)

List databases

Retrieves a list of databases

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (tokenAuth):
import ionoscloud_dbaas_postgres
from ionoscloud_dbaas_postgres.models.database_list import DatabaseList
from ionoscloud_dbaas_postgres.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.ionos.com/databases/postgresql
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud_dbaas_postgres.Configuration(
    host = "https://api.ionos.com/databases/postgresql"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = ionoscloud_dbaas_postgres.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ionoscloud_dbaas_postgres.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_dbaas_postgres.DatabasesApi(api_client)
    cluster_id = '498ae72f-411f-11eb-9d07-046c59cc737e' # str | The unique ID of the cluster.
    limit = 100 # int | The maximum number of elements to return. Use together with 'offset' for pagination. (optional) (default to 100)
    offset = 0 # int | The first element to return. Use together with 'limit' for pagination. (optional) (default to 0)

    try:
        # List databases
        api_response = api_instance.databases_list(cluster_id, limit=limit, offset=offset)
        print("The response of DatabasesApi->databases_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DatabasesApi->databases_list: %s\n" % e)

Parameters

Name Type Description Notes
cluster_id str The unique ID of the cluster.
limit int The maximum number of elements to return. Use together with 'offset' for pagination. [optional] [default to 100]
offset int The first element to return. Use together with 'limit' for pagination. [optional] [default to 0]

Return type

DatabaseList

Authorization

basicAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation. -
0 Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient permissions), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), 503 (maintenance) * Content-Type - application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

databases_post

DatabaseResource databases_post(cluster_id, database)

Create a database

Create a new database

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (tokenAuth):
import ionoscloud_dbaas_postgres
from ionoscloud_dbaas_postgres.models.database import Database
from ionoscloud_dbaas_postgres.models.database_resource import DatabaseResource
from ionoscloud_dbaas_postgres.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.ionos.com/databases/postgresql
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud_dbaas_postgres.Configuration(
    host = "https://api.ionos.com/databases/postgresql"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = ionoscloud_dbaas_postgres.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ionoscloud_dbaas_postgres.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_dbaas_postgres.DatabasesApi(api_client)
    cluster_id = '498ae72f-411f-11eb-9d07-046c59cc737e' # str | The unique ID of the cluster.
    database = ionoscloud_dbaas_postgres.Database() # Database | a database to create

    try:
        # Create a database
        api_response = api_instance.databases_post(cluster_id, database)
        print("The response of DatabasesApi->databases_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DatabasesApi->databases_post: %s\n" % e)

Parameters

Name Type Description Notes
cluster_id str The unique ID of the cluster.
database Database a database to create

Return type

DatabaseResource

Authorization

basicAuth, tokenAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation. -
0 Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient permissions), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), 503 (maintenance) * Content-Type - application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]