Skip to content
Kapten
Esc
↑↓navigate↵open⌘Jpreview

Get a Redis database

Returns a Redis database.

GET/project/{project_id}/environment/{environment_id}/database/redis/{database_id}
Authorization
AuthorizationBearer token (JWT) · headerrequired

JWT token passed in the Authorization header using the Bearer <token> format.

Path parameters
project_iduuidrequired

The unique identifier for the project

environment_iduuidrequired

The unique identifier of the environment

database_iduuidrequired

Unique identifier of the database.

Responses
200

Redis database retrieved successfully

iduuidrequired

A universally unique identifier (UUID) string

organization_iduuidrequired

A universally unique identifier (UUID) string

project_iduuidrequired

A universally unique identifier (UUID) string

cluster_iduuidrequired

A universally unique identifier (UUID) string

environment_iduuidrequired

A universally unique identifier (UUID) string

s_idstringrequired

Short identifier for the database resource.

namestringrequired

Name of the database.

descriptionstring

Optional database description.

typedatabase_typerequired

Database engine type.

Allowed:POSTGRESQLMYSQLMONGODBREDIS
versionstringrequired

Database engine version.

provisioningdatabase_provisioningrequired

Database provisioning strategy.

Allowed:IN_CLUSTERMANAGED
accessibilitydatabase_accessibilityrequired

Database network accessibility.

Allowed:PRIVATEPUBLIC
configurationobjectrequired
Show properties
database_namestring

Logical database name created inside the engine.

encrypt_diskboolean
activate_high_availabilityboolean
activate_backupsboolean
resourcesobjectrequired
Show properties
cpu_request_in_milliinteger<int64>
min 0
cpu_limit_in_milliinteger<int64>
min 0
ram_request_in_mibinteger<int64>
min 0
ram_limit_in_mibinteger<int64>
min 0
disk_size_in_gibinteger<int64>
min 0
database_instance_tierstring
database_disk_typestring
database_disk_iopsinteger<int64>
min 0
created_atstring<date-time>required

Timestamp when the database was created.

updated_atstring<date-time>required

Timestamp when the database was last updated.

deleted_atstring<date-time> | null

Timestamp when the database was deleted.

last_run_iduuid | null

Last component run identifier.

Show properties
Any of:
uuid
string<uuid>
null
null
last_run_statuscomponent_deployment_state | null

Last component run status for the database.

Show properties
Any of:
component_deployment_state
string
null
null
resource_statedatabase_resource_staterequired

Current resource state for the database.

Allowed:OUT_OF_DATEUP_TO_DATENEVER_DEPLOYED
default

Error

codeinteger<int32>required
messagestringrequired
reasonstring

Optional stable machine-readable reason for programmatic error handling

Request
curl -X GET 'https://api.kapten.io/project/497f6eca-6276-4993-bfeb-53cbbbba6f08/environment/497f6eca-6276-4993-bfeb-53cbbbba6f08/database/redis/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
  "s_id": "string",
  "name": "string",
  "description": "string",
  "type": "POSTGRESQL",
  "version": "string",
  "provisioning": "IN_CLUSTER",
  "accessibility": "PRIVATE",
  "configuration": {
    "database_name": "string",
    "encrypt_disk": true,
    "activate_high_availability": true,
    "activate_backups": true,
    "resources": {
      "cpu_request_in_milli": 0,
      "cpu_limit_in_milli": 0,
      "ram_request_in_mib": 0,
      "ram_limit_in_mib": 0,
      "disk_size_in_gib": 0,
      "database_instance_tier": "string",
      "database_disk_type": "string",
      "database_disk_iops": 0
    }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "last_run_id": "08df5d92-87b1-40a2-b1e7-a5977dea4efc",
  "last_run_status": "QUEUED",
  "resource_state": "OUT_OF_DATE"
}

Was this page helpful?