Download OpenAPI specification:Download
Aiven is a modern fully-managed open source data platform for streaming, storing, and analyzing data on any public cloud. On Aiven Platform, you can operate your data infrastructure with a few devops tools: Aiven Console, Aiven Terraform Provider, Aiven CLI, and Aiven Operator for Kubernetes. All of them are built on an open secure powerful REST API for integration with custom tooling.
The Aiven REST API
provides programmatic access to Aiven.io services. To call the Aiven API, you can use either CLI tools (for example, cURL
or Aiven CLI client) or GUI tools, such as the Aiven public API Postman collection.
This Aiven API documentation will help you operate your Aiven organization, projects, or services programmatically by integrating your applications and processes with Aiven.
Aiven's APIs (Application Programming Interfaces) power its platform for data management. Aiven has a number of REST APIs that can help you build strong and robust data infrastructure for your applications.
The Aiven API is organized around core resources. Each core resource has multiple endpoints, which can be interacted with using different HTTP methods.
There are multiple ways you can interact with the Aiven API over HTTP. You can access it by sending requests from a client (for example, a web browser) to the Aiven's server. In this API reference, you'll find code examples of how to do that using cURL
and a few different client libraries (programming languages).
To send an API request, you need to specify the following:
HTTP method
Path
Request headers
Typically, content-type
needs to be set to application/json
: content-type: application/json
. There are a few exceptions though.
Path, query, or body parameters (either required or optional).
curl --request POST \
--url https://api.aiven.io/v1/project/{project}/vpcs \
--header 'Authorization: aivenv1 REPLACE_BEARER_TOKEN' \
--header 'content-type: application/json' \
--data
'{
"cloud_name": "string",
"network_cidr": "string",
"peering_connections": [
{
"peer_azure_app_id": "string",
"peer_azure_tenant_id": "string",
"peer_cloud_account": "string",
"peer_region": "string",
"peer_resource_group": "string",
"peer_vpc": "string",
"user_peer_network_cidrs": [
"string"
]
}
]
}'
Upon receiving and processing a request, the Aiven API returns the response status code, response headers, and a response body in the JSON
format. Response bodies include different properties, which can be either required or optional, for example, the message
property, which is an optional human-readable information on the result of the action (deleted, created, or updated).
{
"cloud_name": "string",
"create_time": "string",
"message": "string",
"network_cidr": "string",
"peering_connections": [
{ ... }
],
"pending_build_only_peering_connections": "string",
"project_vpc_id": "string",
"state": "ACTIVE",
"update_time": "string"
}
A successful API response returns an HTTP result code between 200 and 299.
Example of the created
response
{
"service": {
"service_name": "foobar",
...
}
}
A failed API response returns a HTTP code greater or equal to 400. Additionally, the response may return a list of errors in the response body as JSON, for example
{
"errors": [
{
"error_code": "authentication_failed",
"message": "Authentication failed",
"status": 403,
"metadata": {
...
}
}
],
"message": "Authentication failed"
}
For information on errors' properties and error codes, check Errors.
Check out how to start using the Aiven API either in API quick start or Your first API call.
Header should be of the format authorization: aivenv1 <TOKEN>
. Tokens can be obtained from your Aiven profile page
bearer
OAuth2 security scheme
authorizationCode
https://console.aiven.io/oauth/authorize
https://api.aiven.io/v1/oauth2/token
all
- Provide full access to the API
accounts
- Allow enumerating and reading accounts configuration
accounts:read
- Allow modifying account configuration
accounts:write
- Provides full access to authentication related API
authentication
- Provides full access to authentication related API
authentication:read
- Allow reading authentication related configuration on resources (user profile, accounts)
authentication:write
- Allow modifying authentication related configurations on resources (user profile, accounts)
billing
- Provide full access to billing APIs
billing:read
- Allow reading billing information and configuration
billing:write
- Allow writing billing configuration
payments
- Provide full access to payment method APIs
payments:read
- Allow reading the payment method configurations
payments:write
- Allows writing payment method configuration
privatelink
- Provide full access to private link APIs
privatelink:read
- Allow enumerating and reading private link items and configurations
privatelink:write
- Allow writing (creating, modifying, deleting) private link items
projects
- Provide full access to projects APIs
projects:read
- Allow enumerating projects and reading their configuration
projects:write
- Allow writing (creating, modifying, deleting) projects
scim
- Provide full access to SCIM operations
scim:read
- Allow reading SCIM endpoints
scim:write
- Allow writing (modifying) SCIM endpoints
services
- Provide full access to services APIs
services:read
- Allow enumerating services and reading their configuration
services:write
- Allow writing (creating, modifying, deleting) services
static_ips
- Provide full access to static IPs APIs
static_ips:read
- Allow enumerating and reading static IP items and configurations
static_ips:write
- Allow writing (creating, modifying, deleting) static IP items
tickets
- Provide full access to support ticket APIs
tickets:read
- Allow enumerating and reading support tickets
tickets:write
- Allow writing (creating, modifying) support tickets
user
- Provide full access to user profile APIs
user:read
- Allow reading user profile and configuration
user:write
- Allow writing (modifying) user profile and configuration
When working with the Aiven API, you may encounter different error responses when you attempt to perform operations that can fail. For example, trying to enable writes for a database that has been powered off would lead to the following error response:
{
"errors": [
{
"error_code": "not_powered",
"message": "Database not powered on",
"status": 409
}
],
"message": "Database not powered on"
}
If a request fails with a HTTP code greater or equal to 400, it returns a list of errors in the response body as JSON. errors
objects are embedded in the failed API responses.
{
"errors": [
{
"error_code": "account_not_found",
"message": "Account does not exist",
"status": 404
}
],
"message": "Account does not exist"
}
In an API response, one or more errors may be included in the errors
array of objects. Each error object may contain a few properties:
status
(required) is an HTTP error code, which can be used to programmatically identify the error type.
200
<= status
< 300
means a successful request.300
<= status
<= 500
means a failed request.errors
can have the following HTTPS status codes:
message
(required) is human-readable information on the error.
error_code
is a machine-readable information on the error (see Error codes).
Machine-readable error_code
fields are progressively added to Aiven endpoints to allow you to identify different failure cases programmatically. Currently, the supported values are the following:
account_already_exists
account_already_has_organization
account_and_project_do_not_match
account_and_project_must_belong_same_tenant
account_cannot_be_own_ancestor
account_must_have_enabled_authentication_method
account_not_found
account_team_not_found
account_unit_cannot_create_for_personal_tier
account_unit_cannot_have_billing_group
account_with_child_accounts_cannot_be_deleted
account_with_projects_cannot_be_deleted
action_forbidden_for_managed_users
action_forbidden_for_marketplace_users
action_forbidden_on_unmanaged_users
auth_token_max_age_too_low
authentication_method_disable_current_not_allowed
authentication_method_does_not_allow_auto_join_user_group
authentication_method_not_found
backup_failed
billing_address_not_found
billing_group_not_found
billing_group_organization_active_trial
billing_group_owning_account_must_be_organization
cannot_move_project_not_assigned_to_organization
cannot_remove_managed_users_from_organization
credit_card_not_found
custom_cloud_environment_internal
decline_reason_was_not_provided_when_declining_request
feature_not_enabled
free_trial_extensions_not_available
free_trial_max_extended
free_trial_not_active
free_trial_not_available
governance_group_not_found
internal_server_error
invalid_governance_group_provided
invitation_expired
invitation_not_found
kafka_governance_not_available
kafka_governance_not_enabled
mfa_required_by_organization
mp_account_with_active_subscription_deleted
mp_account_with_commitment_deleted
mp_account_with_support_contract_deleted
mp_subscription_not_found
nested_account_cannot_have_authentication_method
nested_account_cannot_have_user_groups
node_prune_version_not_updated
not_powered
optimization_failed
organization_aiven_enterprise_contract_denied
organization_aiven_enterprise_denied
organization_cannot_exist_without_root_account
organization_domain_already_linked
organization_domain_not_found
organization_domain_verification_failed
organization_kafka_topics_invalid_filters
organization_mismatch
organization_must_have_one_super_admin
organization_not_found
organization_tier_downgrade_not_allowed
orphaned_project_not_allowed
parent_account_cannot_be_own_ancestor
parent_account_not_found
parent_account_tenant_invalid
parent_account_too_deep
project_account_not_active
project_belongs_to_account_billing_group_must_use_api
project_has_no_such_user
project_limitation_not_found
project_not_found
project_without_billing_group_must_be_assigned_from_account
request_forbidden
request_not_found
resource_managed_by_scim
resource_not_managed_by_scim
root_account_required
same_organization_required
service_acl_not_found
service_acl_too_many
service_integration_endpoint_not_found
service_integration_not_found
signup_welcome_invalid_key
stripe_customer_owning_account_must_be_organization
support_contract_and_account_must_be_in_same_organization
support_contract_must_have_billing_group
team_limit_exceeded
team_names_must_be_unique
tenant_mismatch
unable_to_parse_query
unit_cannot_be_moved_out_of_organization
user_already_in_organization
user_already_invited_to_organization
user_config_2fa_otp_verification_failed
user_deactivated
user_domain_does_not_belong_to_organization_or_no_linked_auth_method
user_group_names_must_be_unique
user_group_not_found
user_groups_belong_to_different_accounts
user_groups_must_be_from_same_account
user_has_no_access_to_billing_info
user_has_no_access_to_project_with_current_authentication_method
user_has_to_sign_in_with_non_account_authentication_method
user_has_too_many_disk_addition_requests
user_not_account_owner
user_not_account_owner_of_billing_group
user_not_account_owner_of_parent_account
user_not_admin_of_account_billing_group
user_not_found
user_not_managed_by_organization
user_not_organization_admin
user_not_signed_in_with_account_authentication_method
user_oauth_authentication_method_not_allowed
user_password_authentication_method_not_allowed
user_role_not_allowed_to_perform_operation
user_saml_authentication_method_not_allowed
user_weblink_action_expired
users_belong_to_different_tenant_from_user_group_account
account_id required | string Account ID |
payment_method_id required | string <= 256 characters Unique identifier for a Stripe payment method |
{- "payment_method_id": "string"
}
{- "card": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "organization_id": "string",
- "projects": [
- "string"
]
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/payment_methods', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "cards": [
- {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
auth_token_extend_when_used | boolean Extend authentication token validity when used |
auth_token_max_age_seconds | integer [ 300 .. 1296000 ] Auth Token Max Age Seconds |
authentication_method_name required | string <= 128 characters Authentication Method Name |
authentication_method_type required | string Enum: "internal" "saml" Authentication method type |
auto_join_team_id | string <= 32 characters Automatically add users to a team, when user signs up using this authentication method |
auto_join_user_group_id | string <= 36 characters Automatically add users to a group, when user signs up using this authentication method |
Array of objects Linked Domains | |
saml_assertion_signed_enabled | boolean Set to 'true' to enable WantAssertionsSigned |
saml_authn_requests_signed_enabled | boolean Set to 'true' to enable AuthnRequestsSigned |
saml_certificate | string <= 16384 characters Identity provider's certificate |
saml_digest_algorithm | string Enum: "sha1" "sha256" "sha384" "sha512" Digest algorithm. This is an advanced option that typically does not need to be set. |
saml_entity_id | string <= 2048 characters Saml Entity ID |
object SAMLFieldMapping | |
saml_idp_login_allowed | boolean Set to 'true' to enable IdP initiated login |
saml_idp_url | string <= 2048 characters Saml Idp Url |
saml_requested_authn_context_enabled | boolean Set to 'false' to disable RequestedAuthnContext |
saml_signature_algorithm | string Enum: "rsa-sha1" "dsa-sha1" "rsa-sha256" "rsa-sha384" "rsa-sha512" SAMLSignatureAlgorithm |
saml_variant | string Value: "adfs" SAMLVariant |
scim_enabled | boolean SCIM enabled |
{- "auth_token_extend_when_used": true,
- "auth_token_max_age_seconds": 300,
- "authentication_method_name": "string",
- "authentication_method_type": "internal",
- "auto_join_team_id": "string",
- "auto_join_user_group_id": "string",
- "linked_domains": [
- {
- "domain_id": "string"
}
], - "saml_assertion_signed_enabled": true,
- "saml_authn_requests_signed_enabled": true,
- "saml_certificate": "string",
- "saml_digest_algorithm": "sha1",
- "saml_entity_id": "string",
- "saml_field_mapping": {
- "email": "string",
- "first_name": "string",
- "identity": "string",
- "last_name": "string",
- "real_name": "string"
}, - "saml_idp_login_allowed": true,
- "saml_idp_url": "string",
- "saml_requested_authn_context_enabled": true,
- "saml_signature_algorithm": "rsa-sha1",
- "saml_variant": "adfs",
- "scim_enabled": true
}
{- "authentication_method": {
- "account_id": "string",
- "auth_token_extend_when_used": true,
- "auth_token_max_age_seconds": 300,
- "authentication_method_enabled": true,
- "authentication_method_id": "string",
- "authentication_method_name": "string",
- "authentication_method_type": "internal",
- "auto_join_team_id": "string",
- "auto_join_user_group_id": "string",
- "create_time": "string",
- "delete_time": "string",
- "organization_id": "string",
- "saml_acs_url": "string",
- "saml_assertion_signed_enabled": true,
- "saml_authn_requests_signed_enabled": true,
- "saml_cert": "adfs",
- "saml_certificate": "string",
- "saml_certificate_issuer": "string",
- "saml_certificate_not_valid_after": "string",
- "saml_certificate_not_valid_before": "string",
- "saml_certificate_subject": "string",
- "saml_digest_algorithm": "sha1",
- "saml_entity_id": "string",
- "saml_field_mapping": {
- "email": "string",
- "first_name": "string",
- "identity": "string",
- "last_name": "string",
- "real_name": "string"
}, - "saml_idp_login_allowed": true,
- "saml_idp_url": "string",
- "saml_metadata_url": "string",
- "saml_requested_authn_context_enabled": true,
- "saml_signature_algorithm": "rsa-sha1",
- "saml_sp_certificate": "string",
- "saml_variant": "adfs",
- "scim_enabled": true,
- "scim_url": "string",
- "state": "active",
- "update_time": "string"
}
}
account_id required | string Account ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/authentication', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "authentication_methods": [
- {
- "account_id": "string",
- "auth_token_extend_when_used": true,
- "auth_token_max_age_seconds": 300,
- "authentication_method_enabled": true,
- "authentication_method_id": "string",
- "authentication_method_name": "string",
- "authentication_method_type": "internal",
- "auto_join_team_id": "string",
- "auto_join_user_group_id": "string",
- "create_time": "string",
- "delete_time": "string",
- "organization_id": "string",
- "saml_acs_url": "string",
- "saml_assertion_signed_enabled": true,
- "saml_authn_requests_signed_enabled": true,
- "saml_cert": "adfs",
- "saml_certificate": "string",
- "saml_certificate_issuer": "string",
- "saml_certificate_not_valid_after": "string",
- "saml_certificate_not_valid_before": "string",
- "saml_certificate_subject": "string",
- "saml_digest_algorithm": "sha1",
- "saml_entity_id": "string",
- "saml_field_mapping": {
- "email": "string",
- "first_name": "string",
- "identity": "string",
- "last_name": "string",
- "real_name": "string"
}, - "saml_idp_login_allowed": true,
- "saml_idp_url": "string",
- "saml_metadata_url": "string",
- "saml_requested_authn_context_enabled": true,
- "saml_signature_algorithm": "rsa-sha1",
- "saml_sp_certificate": "string",
- "saml_variant": "adfs",
- "scim_enabled": true,
- "scim_url": "string",
- "state": "active",
- "update_time": "string"
}
]
}
account_id required | string Account ID |
account_authentication_method_id required | string Account authentication method ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/authentication/%7Baccount_authentication_method_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "message": "string"
}
account_id required | string Account ID |
account_authentication_method_id required | string Account authentication method ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/authentication/%7Baccount_authentication_method_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "authentication_method": {
- "account_id": "string",
- "auth_token_extend_when_used": true,
- "auth_token_max_age_seconds": 300,
- "authentication_method_enabled": true,
- "authentication_method_id": "string",
- "authentication_method_name": "string",
- "authentication_method_type": "internal",
- "auto_join_team_id": "string",
- "auto_join_user_group_id": "string",
- "create_time": "string",
- "delete_time": "string",
- "organization_id": "string",
- "saml_acs_url": "string",
- "saml_assertion_signed_enabled": true,
- "saml_authn_requests_signed_enabled": true,
- "saml_cert": "adfs",
- "saml_certificate": "string",
- "saml_certificate_issuer": "string",
- "saml_certificate_not_valid_after": "string",
- "saml_certificate_not_valid_before": "string",
- "saml_certificate_subject": "string",
- "saml_digest_algorithm": "sha1",
- "saml_entity_id": "string",
- "saml_field_mapping": {
- "email": "string",
- "first_name": "string",
- "identity": "string",
- "last_name": "string",
- "real_name": "string"
}, - "saml_idp_login_allowed": true,
- "saml_idp_url": "string",
- "saml_metadata_url": "string",
- "saml_requested_authn_context_enabled": true,
- "saml_signature_algorithm": "rsa-sha1",
- "saml_sp_certificate": "string",
- "saml_variant": "adfs",
- "scim_enabled": true,
- "scim_url": "string",
- "state": "active",
- "update_time": "string"
}
}
account_id required | string Account ID |
account_authentication_method_id required | string Account authentication method ID |
auth_token_extend_when_used | boolean Extend authentication token validity when used |
auth_token_max_age_seconds | integer [ 300 .. 1296000 ] Auth Token Max Age Seconds |
authentication_method_enabled | boolean If true, authentication method can be used to access account/projects in account. If false, authentication method can still be used to sign in |
authentication_method_name | string <= 128 characters Authentication Method Name |
auto_join_team_id | string <= 32 characters Automatically add users to a team, when user signs up using this authentication method |
auto_join_user_group_id | string <= 36 characters Automatically add users to a group, when user signs up using this authentication method |
saml_assertion_signed_enabled | boolean Set to 'true' to enable WantAssertionsSigned |
saml_authn_requests_signed_enabled | boolean Set to 'true' to enable AuthnRequestsSigned |
saml_certificate | string <= 16384 characters Identity provider's certificate |
saml_digest_algorithm | string Enum: "sha1" "sha256" "sha384" "sha512" Digest algorithm. This is an advanced option that typically does not need to be set. |
saml_entity_id | string <= 2048 characters Saml Entity ID |
object SAMLFieldMapping | |
saml_idp_login_allowed | boolean Set to 'true' to enable IdP initiated login |
saml_idp_url | string <= 2048 characters Saml Idp Url |
saml_requested_authn_context_enabled | boolean Set to 'false' to disable RequestedAuthnContext |
saml_signature_algorithm | string Enum: "rsa-sha1" "dsa-sha1" "rsa-sha256" "rsa-sha384" "rsa-sha512" SAMLSignatureAlgorithm |
saml_variant | string Value: "adfs" SAMLVariant |
scim_enabled | boolean SCIM enabled |
{- "auth_token_extend_when_used": true,
- "auth_token_max_age_seconds": 300,
- "authentication_method_enabled": true,
- "authentication_method_name": "string",
- "auto_join_team_id": "string",
- "auto_join_user_group_id": "string",
- "saml_assertion_signed_enabled": true,
- "saml_authn_requests_signed_enabled": true,
- "saml_certificate": "string",
- "saml_digest_algorithm": "sha1",
- "saml_entity_id": "string",
- "saml_field_mapping": {
- "email": "string",
- "first_name": "string",
- "identity": "string",
- "last_name": "string",
- "real_name": "string"
}, - "saml_idp_login_allowed": true,
- "saml_idp_url": "string",
- "saml_requested_authn_context_enabled": true,
- "saml_signature_algorithm": "rsa-sha1",
- "saml_variant": "adfs",
- "scim_enabled": true
}
{- "authentication_method": {
- "account_id": "string",
- "auth_token_extend_when_used": true,
- "auth_token_max_age_seconds": 300,
- "authentication_method_enabled": true,
- "authentication_method_id": "string",
- "authentication_method_name": "string",
- "authentication_method_type": "internal",
- "auto_join_team_id": "string",
- "auto_join_user_group_id": "string",
- "create_time": "string",
- "delete_time": "string",
- "organization_id": "string",
- "saml_acs_url": "string",
- "saml_assertion_signed_enabled": true,
- "saml_authn_requests_signed_enabled": true,
- "saml_cert": "adfs",
- "saml_certificate": "string",
- "saml_certificate_issuer": "string",
- "saml_certificate_not_valid_after": "string",
- "saml_certificate_not_valid_before": "string",
- "saml_certificate_subject": "string",
- "saml_digest_algorithm": "sha1",
- "saml_entity_id": "string",
- "saml_field_mapping": {
- "email": "string",
- "first_name": "string",
- "identity": "string",
- "last_name": "string",
- "real_name": "string"
}, - "saml_idp_login_allowed": true,
- "saml_idp_url": "string",
- "saml_metadata_url": "string",
- "saml_requested_authn_context_enabled": true,
- "saml_signature_algorithm": "rsa-sha1",
- "saml_sp_certificate": "string",
- "saml_variant": "adfs",
- "scim_enabled": true,
- "scim_url": "string",
- "state": "active",
- "update_time": "string"
}
}
account_id required | string Account ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/billing-group', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "account_billing_groups": [
- {
- "account_id": "string",
- "account_name": "string",
- "address_lines": [
- "string"
], - "billing_address": "string",
- "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "card_info": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "user_email": "string"
}, - "city": "string",
- "company": "string",
- "country": "string",
- "country_code": "st",
- "create_time": "string",
- "estimated_balance_local": "string",
- "estimated_balance_usd": "string",
- "payment_method": "accrual",
- "state": "string",
- "vat_id": "string",
- "zip_code": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_name required | string <= 128 characters Account name |
parent_account_id | string <= 36 characters Account ID |
primary_billing_group_id | string = 36 characters Billing group ID |
{- "account_name": "string",
- "parent_account_id": "string",
- "primary_billing_group_id": "stringstringstringstringstringstring"
}
{- "account": {
- "access_source": "descendant_membership",
- "account_id": "string",
- "account_name": "string",
- "account_owner_team_id": "string",
- "create_time": "string",
- "features": { },
- "is_account_member": true,
- "is_account_owner": true,
- "organization_id": "string",
- "parent_account_id": "string",
- "primary_billing_group_id": "stringstringstringstringstringstring",
- "root_account_id": "string",
- "tenant_id": "string",
- "update_time": "string"
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "accounts": [
- {
- "access_source": "descendant_membership",
- "account_id": "string",
- "account_name": "string",
- "account_owner_team_id": "string",
- "create_time": "string",
- "features": { },
- "is_account_member": true,
- "is_account_owner": true,
- "organization_id": "string",
- "parent_account_id": "string",
- "primary_billing_group_id": "stringstringstringstringstringstring",
- "root_account_id": "string",
- "tenant_id": "string",
- "update_time": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "account": {
- "access_source": "descendant_membership",
- "account_id": "string",
- "account_name": "string",
- "account_owner_team_id": "string",
- "create_time": "string",
- "features": { },
- "is_account_member": true,
- "is_account_owner": true,
- "organization_id": "string",
- "parent_account_id": "string",
- "primary_billing_group_id": "stringstringstringstringstringstring",
- "root_account_id": "string",
- "tenant_id": "string",
- "update_time": "string"
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
account_name | string <= 128 characters Account name |
primary_billing_group_id | string = 36 characters Billing group ID |
{- "account_name": "string",
- "primary_billing_group_id": "stringstringstringstringstringstring"
}
{- "account": {
- "access_source": "descendant_membership",
- "account_id": "string",
- "account_name": "string",
- "account_owner_team_id": "string",
- "create_time": "string",
- "features": { },
- "is_account_member": true,
- "is_account_owner": true,
- "organization_id": "string",
- "parent_account_id": "string",
- "primary_billing_group_id": "stringstringstringstringstringstring",
- "root_account_id": "string",
- "tenant_id": "string",
- "update_time": "string"
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/events', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "events": [
- {
- "account_id": "string",
- "action_description": "string",
- "action_type": "string",
- "actor": "string",
- "actor_user_id": "string",
- "create_time": "string",
- "log_entry_id": 0,
- "team_id": "string"
}
], - "message": "string"
}
account_id required | string Account ID |
parent_account_id required | string <= 36 characters Account ID |
{- "parent_account_id": "string"
}
{- "account": {
- "access_source": "descendant_membership",
- "account_id": "string",
- "account_name": "string",
- "account_owner_team_id": "string",
- "create_time": "string",
- "features": { },
- "is_account_member": true,
- "is_account_owner": true,
- "organization_id": "string",
- "parent_account_id": "string",
- "primary_billing_group_id": "stringstringstringstringstringstring",
- "root_account_id": "string",
- "tenant_id": "string",
- "update_time": "string"
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
card_id required | string Credit card ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/payment_method/%7Bcard_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/projects', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "projects": [
- {
- "account_id": "string",
- "account_name": "string",
- "address_lines": [
- "string"
], - "available_credits": "string",
- "billing_address": "string",
- "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "card_info": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "user_email": "string"
}, - "city": "string",
- "company": "string",
- "country": "string",
- "country_code": "st",
- "default_cloud": "string",
- "end_of_life_extension": {
- "elasticsearch": {
- "eol_date": "string",
- "version": "string"
}
}, - "estimated_balance": "string",
- "estimated_balance_local": "string",
- "features": { },
- "organization_id": "string",
- "payment_method": "string",
- "project_name": "string",
- "state": "string",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "tenant_id": "string",
- "trial_expiration_time": "string",
- "vat_id": "string",
- "zip_code": "string"
}
], - "total_project_count": 0
}
Use GET /organization/{organization_id}/user-groups
account_id required | string Account ID |
project_name required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/project/%7Bproject_name%7D/teams', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "teams": [
- {
- "account_id": "string",
- "create_time": "string",
- "team_id": "string",
- "team_name": "string",
- "team_type": "admin",
- "update_time": "string"
}
]
}
Use POST /organization/{organization_id}/user-groups
account_id required | string Account ID |
team_name required | string <= 128 characters Team name |
{- "team_name": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "team": {
- "account_id": "string",
- "create_time": "string",
- "team_id": "string",
- "team_name": "string",
- "update_time": "string"
}
}
account_id required | string Account ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/teams', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "teams": [
- {
- "account_id": "string",
- "create_time": "string",
- "team_id": "string",
- "team_name": "string",
- "update_time": "string"
}
]
}
account_id required | string Account ID |
team_id required | string Team ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/team/%7Bteam_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
team_id required | string Team ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/team/%7Bteam_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "team": {
- "account_id": "string",
- "create_time": "string",
- "team_id": "string",
- "team_name": "string",
- "update_time": "string"
}
}
account_id required | string Account ID |
team_id required | string Team ID |
team_name required | string <= 128 characters Team name |
{- "team_name": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "team": {
- "account_id": "string",
- "create_time": "string",
- "team_id": "string",
- "team_name": "string",
- "update_time": "string"
}
}
account_id required | string Account ID |
team_id required | string Team ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/team/%7Bteam_id%7D/invites', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "account_invites": [
- {
- "account_id": "string",
- "account_name": "string",
- "create_time": "string",
- "invited_by_user_email": "string",
- "team_id": "string",
- "team_name": "string",
- "user_email": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
team_id required | string Team ID |
user_email required | string Email address |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/team/%7Bteam_id%7D/invites/%7Buser_email%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
invite_verification_code required | string Verification code received via email |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/invite/%7Binvite_verification_code%7D' }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "invite_details": {
- "user_email": "string"
}, - "message": "string"
}
Use DELETE /organization/{organization_id}/user/{member_user_id}
account_id required | string Account ID |
team_id required | string Team ID |
user_id required | string User ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/team/%7Bteam_id%7D/member/%7Buser_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
team_id required | string Team ID |
email required | string <= 319 characters User email address |
{- "email": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
team_id required | string Team ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/team/%7Bteam_id%7D/members', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "members": [
- {
- "create_time": "string",
- "real_name": "string",
- "team_id": "string",
- "team_name": "string",
- "update_time": "string",
- "user_email": "string",
- "user_id": "string"
}
], - "message": "string"
}
account_id required | string Account ID |
team_id required | string Team ID |
project required | string Project name |
team_type required | string Enum: "admin" "operator" "developer" "read_only" Team type (permission level) |
{- "team_type": "admin"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
Use PATCH /organization/{organization_id}/user-groups/{user_group_id}
account_id required | string Account ID |
team_id required | string Team ID |
project required | string Project name |
team_type | string Enum: "admin" "operator" "developer" "read_only" Team type (permission level) |
{- "team_type": "admin"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string Account ID |
team_id required | string Team ID |
project required | string Project name |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/team/%7Bteam_id%7D/project/%7Bproject%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
Use GET /organization/{organization_id}/projects
account_id required | string Account ID |
team_id required | string Team ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/team/%7Bteam_id%7D/projects', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "projects": [
- {
- "project_name": "string",
- "team_type": "admin"
}
]
}
account_id required | string Account ID |
user_id required | string User ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/user/%7Buser_id%7D/projects', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "user_projects": [
- {
- "access_type": "string",
- "account_id": "string",
- "create_time": "string",
- "member_type": "admin",
- "project_name": "string",
- "real_name": "string",
- "team_id": "string",
- "team_name": "string",
- "user_email": "string"
}
]
}
Use GET /organization/{organization_id}/user/{member_user_id}/user-groups
account_id required | string Account ID |
user_id required | string User ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/account/%7Baccount_id%7D/user/%7Buser_id%7D/teams', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "teams": [
- {
- "account_id": "string",
- "account_name": "string",
- "team_id": "string",
- "team_name": "string"
}
]
}
account_id required | string Account ID |
limit | integer [ 1 .. 500 ] Maximum number of results to return |
order_by | string Enum: "user_email:asc" "user_email:desc" "user_id:asc" "user_id:desc" "real_name:asc" "real_name:desc" Sorting criteria; desc is descending order and asc ascending |
query | string <= 128 characters Filter keyword |
{- "limit": 1,
- "order_by": "user_email:asc",
- "query": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "users": [
- {
- "real_name": "string",
- "user_email": "string",
- "user_id": "string"
}
]
}
account_id | string <= 36 characters Account ID |
address_lines | Array of strings <= 16 items Address lines |
billing_currency | string Enum: "AUD" "CAD" "CHF" "DKK" "EUR" "GBP" "JPY" "NOK" "NZD" "SEK" "SGD" "USD" Billing currency |
Array of objects <= 10 items List of project billing email addresses | |
billing_extra_text | string <= 1000 characters Extra text to be included in all project invoices, e.g. purchase order or cost center number |
billing_group_name required | string <= 128 characters Billing group name |
card_id | string <= 64 characters Credit card ID |
city | string <= 512 characters Address city |
company | string <= 128 characters Name of a company |
copy_from_billing_group | string = 36 characters Billing group ID |
country_code | string <= 2 characters Two letter country code for billing country |
state | string <= 128 characters Address state |
vat_id | string <= 64 characters EU VAT Identification Number |
zip_code | string <= 32 characters Address zip code |
{- "account_id": "string",
- "address_lines": [
- "string"
], - "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_name": "string",
- "card_id": "string",
- "city": "string",
- "company": "string",
- "copy_from_billing_group": "stringstringstringstringstringstring",
- "country_code": "st",
- "state": "string",
- "vat_id": "string",
- "zip_code": "string"
}
{- "billing_group": {
- "account_id": "string",
- "account_name": "string",
- "address_lines": [
- "string"
], - "billing_address": "string",
- "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "card_info": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "user_email": "string"
}, - "city": "string",
- "company": "string",
- "country": "string",
- "country_code": "st",
- "create_time": "string",
- "estimated_balance_local": "string",
- "estimated_balance_usd": "string",
- "payment_method": "accrual",
- "state": "string",
- "vat_id": "string",
- "zip_code": "string"
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/billing-group', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "billing_groups": [
- {
- "account_id": "string",
- "account_name": "string",
- "address_lines": [
- "string"
], - "billing_address": "string",
- "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "card_info": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "user_email": "string"
}, - "city": "string",
- "company": "string",
- "country": "string",
- "country_code": "st",
- "create_time": "string",
- "estimated_balance_local": "string",
- "estimated_balance_usd": "string",
- "payment_method": "accrual",
- "state": "string",
- "vat_id": "string",
- "zip_code": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
billing_group_id required | string Billing group id |
code required | string <= 1024 characters Credit code |
{- "code": "string"
}
{- "credit": {
- "code": "string",
- "expire_time": "string",
- "remaining_value": "string",
- "start_time": "string",
- "type": "discount",
- "value": "string"
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
billing_group_id required | string Billing group id |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/billing-group/%7Bbilling_group_id%7D/credits', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "credits": [
- {
- "code": "string",
- "expire_time": "string",
- "remaining_value": "string",
- "start_time": "string",
- "type": "discount",
- "value": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
billing_group_id required | string Billing group id |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/billing-group/%7Bbilling_group_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
billing_group_id required | string Billing group id |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/billing-group/%7Bbilling_group_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "billing_group": {
- "account_id": "string",
- "account_name": "string",
- "address_lines": [
- "string"
], - "billing_address": "string",
- "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "card_info": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "user_email": "string"
}, - "city": "string",
- "company": "string",
- "country": "string",
- "country_code": "st",
- "create_time": "string",
- "estimated_balance_local": "string",
- "estimated_balance_usd": "string",
- "payment_method": "accrual",
- "state": "string",
- "vat_id": "string",
- "zip_code": "string"
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
billing_group_id required | string Billing group id |
account_id | string <= 36 characters Account ID |
address_lines | Array of strings <= 16 items Address lines |
billing_currency | string Enum: "AUD" "CAD" "CHF" "DKK" "EUR" "GBP" "JPY" "NOK" "NZD" "SEK" "SGD" "USD" Billing currency |
Array of objects <= 10 items List of project billing email addresses | |
billing_extra_text | string <= 1000 characters Extra text to be included in all project invoices, e.g. purchase order or cost center number |
billing_group_name | string <= 128 characters Billing group name |
card_id | string <= 64 characters Credit card ID |
city | string <= 512 characters Address city |
company | string <= 128 characters Name of a company |
country_code | string <= 2 characters Two letter country code for billing country |
state | string <= 128 characters Address state |
vat_id | string <= 64 characters EU VAT Identification Number |
zip_code | string <= 32 characters Address zip code |
{- "account_id": "string",
- "address_lines": [
- "string"
], - "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_name": "string",
- "card_id": "string",
- "city": "string",
- "company": "string",
- "country_code": "st",
- "state": "string",
- "vat_id": "string",
- "zip_code": "string"
}
{- "billing_group": {
- "account_id": "string",
- "account_name": "string",
- "address_lines": [
- "string"
], - "billing_address": "string",
- "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "card_info": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "user_email": "string"
}, - "city": "string",
- "company": "string",
- "country": "string",
- "country_code": "st",
- "create_time": "string",
- "estimated_balance_local": "string",
- "estimated_balance_usd": "string",
- "payment_method": "accrual",
- "state": "string",
- "vat_id": "string",
- "zip_code": "string"
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
billing_group_id required | string Billing group id |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/billing-group/%7Bbilling_group_id%7D/events', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "events": [
- {
- "actor": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "create_time": "string",
- "event_desc": "string",
- "event_type": "string",
- "log_entry_id": 0,
- "project_id": "string",
- "project_name": "string"
}
], - "message": "string"
}
billing_group_id required | string Billing group id |
invoice_number required | string Invoice number |
cookie required | string Download cookie signature. |
project | string Project name. Only required if the provided cookie comes from the Project Billing API. |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/billing-group/%7Bbilling_group_id%7D/invoice/%7Binvoice_number%7D/csv', qs: {cookie: 'SOME_STRING_VALUE', project: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
billing_group_id required | string Billing group id |
invoice_number required | string Invoice number |
download_cookie required | string Authentication cookie for file download |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/billing-group/%7Bbilling_group_id%7D/invoice/%7Binvoice_number%7D/%7Bdownload_cookie%7D' }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
Use GET /invoices/{invoice_number}
billing_group_id required | string Billing group id |
invoice_number required | string Invoice number |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/billing-group/%7Bbilling_group_id%7D/invoice/%7Binvoice_number%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "invoice": {
- "generated_at": "string",
- "invoice_number": "string",
- "invoice_state": "accrual",
- "local_inc_vat": "string",
- "local_vat_zero": "string"
}, - "message": "string"
}
billing_group_id required | string Billing group id |
invoice_number required | string Invoice number |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/billing-group/%7Bbilling_group_id%7D/invoice/%7Binvoice_number%7D/lines', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "lines": [
- {
- "cloud_name": "string",
- "commitment_name": "string",
- "description": "string",
- "line_pre_discount_local": "string",
- "line_total_local": "string",
- "line_total_usd": "string",
- "line_type": "commitment_fee",
- "local_currency": "string",
- "project_name": "string",
- "service_name": "string",
- "service_plan": "string",
- "service_type": "alertmanager",
- "tags": { },
- "timestamp_begin": "string",
- "timestamp_end": "string"
}
], - "message": "string"
}
billing_group_id required | string Billing group id |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/billing-group/%7Bbilling_group_id%7D/invoice', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "invoices": [
- {
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "billing_group_state": "active",
- "currency": "AUD",
- "download_cookie": "string",
- "generated_at": "string",
- "invoice_number": "string",
- "period_begin": "string",
- "period_end": "string",
- "state": "accrual",
- "total_inc_vat": "string",
- "total_vat_zero": "string"
}
], - "message": "string"
}
billing_group_id required | string Billing group id |
project required | string Project name |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/billing-group/%7Bbilling_group_id%7D/project-assign/%7Bproject%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
billing_group_id required | string Billing group id |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/billing-group/%7Bbilling_group_id%7D/projects', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "projects": [
- {
- "available_credits": "string",
- "estimated_balance": "string",
- "project_name": "string"
}
]
}
billing_group_id required | string Billing group id |
projects_names required | Array of strings [ 1 .. 1024 ] items Projects names |
{- "projects_names": [
- "string"
]
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
invoice_number required | string Invoice number |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/invoices/%7Binvoice_number%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "invoice": {
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "billing_group_state": "string",
- "currency": "string",
- "download_cookie": "string",
- "generated_at": "string",
- "invoice_number": "string",
- "period_begin": "string",
- "period_end": "string",
- "state": "string",
- "total_inc_vat": "string",
- "total_vat_zero": "string"
}
}
const request = require('request'); const options = {method: 'GET', url: 'https://api.aiven.io/v1/clouds'}; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "clouds": [
- {
- "cloud_description": "string",
- "cloud_name": "string",
- "geo_latitude": 0,
- "geo_longitude": 0,
- "geo_region": "string",
- "provider": "string",
- "provider_description": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
Returns a list of cloud platforms available for a project.
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/clouds', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "clouds": [
- {
- "cloud_description": "string",
- "cloud_name": "string",
- "geo_latitude": 0,
- "geo_longitude": 0,
- "geo_region": "string",
- "provider": "string",
- "provider_description": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
Returns a list of cloud platforms supporting privatelink along with privatelink costs for specific cloud platforms.
tenant required | string Aiven tenant ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/tenants/%7Btenant%7D/privatelink-availability' }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "privatelink_availability": [
- {
- "cloud_name": "string",
- "price_usd": "string"
}
]
}
Returns a list of cloud platforms supporting static IP addresses along with static IP addresses costs for specific cloud platforms.
tenant required | string Aiven tenant ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/tenants/%7Btenant%7D/static-ip-availability' }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "static_ip_address_availability": [
- {
- "cloud_name": "string",
- "price_usd": "string"
}
]
}
Creates a new domain in an organization.
organization_id required | string ID of an organization |
domain_name required | string Name of the domain to be added |
verification_type required | string Enum: "dns" "http" Type of verification to be made |
{- "domain_name": "string",
- "verification_type": "dns"
}
{- "challenge_token": "string",
- "create_time": "string",
- "domain_id": "string",
- "domain_name": "string",
- "linked_authentication_method_ids": [
- "string"
], - "organization_id": "string",
- "state": "deleted",
- "verification_type": "dns"
}
Returns a list of all verified domains in an organization.
organization_id required | string ID of an organization |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/domains', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "domains": [
- {
- "challenge_token": "string",
- "create_time": "string",
- "domain_id": "string",
- "domain_name": "string",
- "linked_authentication_method_ids": [
- "string"
], - "organization_id": "string",
- "state": "deleted",
- "verification_type": "dns"
}
]
}
Updates a domain in an organization.
organization_id required | string ID of an organization |
domain_id required | string ID of a domain |
verification_type | string Enum: "dns" "http" OrganizationDomainVerificationType |
{- "verification_type": "dns"
}
{- "challenge_token": "string",
- "create_time": "string",
- "domain_id": "string",
- "domain_name": "string",
- "linked_authentication_method_ids": [
- "string"
], - "organization_id": "string",
- "state": "deleted",
- "verification_type": "dns"
}
Deletes a domain from an organization.
organization_id required | string ID of an organization |
domain_id required | string ID of a domain |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/domains/%7Bdomain_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
Verifies a domain in an organization. If a user signs up to the Aiven platform with a verified domain, they are automatically added as managed users to the organization that has this domain verified.
organization_id required | string ID of an organization |
domain_id required | string ID of a domain |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/domains/%7Bdomain_id%7D/verify', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "challenge_token": "string",
- "create_time": "string",
- "domain_id": "string",
- "domain_name": "string",
- "linked_authentication_method_ids": [
- "string"
], - "organization_id": "string",
- "state": "deleted",
- "verification_type": "dns"
}
Create a new user group in an organization
organization_id required | string ID of an organization |
description required | string <= 4096 characters Description |
user_group_name required | string <= 128 characters User Group Name |
{- "description": "string",
- "user_group_name": "string"
}
{- "create_time": "string",
- "description": "string",
- "managed_by_scim": true,
- "update_time": "string",
- "user_group_id": "string",
- "user_group_name": "string"
}
List all user groups within an organization
organization_id required | string ID of an organization |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/user-groups', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "user_groups": [
- {
- "create_time": "string",
- "description": "string",
- "managed_by_scim": true,
- "member_count": 0,
- "update_time": "string",
- "user_group_id": "string",
- "user_group_name": "string"
}
]
}
Delete a user group from an organization
organization_id required | string ID of an organization |
user_group_id required | string ID of the user group |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/user-groups/%7Buser_group_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "message": "string",
- "errors": [
- {
- "message": "string",
- "error_code": "resource_managed_by_scim"
}
]
}
Retrieve the details of a user group
organization_id required | string ID of an organization |
user_group_id required | string ID of the user group |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/user-groups/%7Buser_group_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "create_time": "string",
- "description": "string",
- "managed_by_scim": true,
- "update_time": "string",
- "user_group_id": "string",
- "user_group_name": "string"
}
Update details of a user group
organization_id required | string ID of an organization |
user_group_id required | string ID of the user group |
description | string <= 4096 characters Description |
user_group_name | string <= 128 characters User Group Name |
{- "description": "string",
- "user_group_name": "string"
}
{- "create_time": "string",
- "description": "string",
- "managed_by_scim": true,
- "update_time": "string",
- "user_group_id": "string",
- "user_group_name": "string"
}
List members of a user group
organization_id required | string ID of an organization |
user_group_id required | string ID of the user group |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/user-groups/%7Buser_group_id%7D/members', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "members": [
- {
- "last_activity_time": "string",
- "user_id": "string",
- "user_info": {
- "city": "string",
- "country": "string",
- "create_time": "string",
- "department": "string",
- "is_application_user": true,
- "job_title": "string",
- "managed_by_scim": true,
- "managing_organization_id": "string",
- "real_name": "string",
- "state": "string",
- "user_email": "string"
}
}
]
}
Add or remove members of a user group
organization_id required | string ID of an organization |
user_group_id required | string ID of the user group |
member_ids required | Array of strings <= 1024 items List of user IDs to apply the operation on |
operation required | string Enum: "add_members" "remove_members" Operation to be performed on the group |
{- "member_ids": [
- "string"
], - "operation": "add_members"
}
{- "message": "string",
- "errors": [
- {
- "message": "string",
- "error_code": "resource_managed_by_scim"
}
]
}
Retrieve current authentication configuration for an organization.
organization_id required | string ID of an organization |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/config/authentication', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "oauth_enabled": true,
- "password_auth_enabled": true,
- "saml_enabled": true,
- "two_factor_required": true
}
Update current authentication configuration for an organization.
organization_id required | string ID of an organization |
oauth_enabled | boolean Organization users are able to use OAuth authentication. |
password_auth_enabled | boolean Organization users are able to use password authentication. |
saml_enabled | boolean Organization users are able to use SAML authentication. |
two_factor_required | boolean 2FA is required to access resources in this organization. |
{- "oauth_enabled": true,
- "password_auth_enabled": true,
- "saml_enabled": true,
- "two_factor_required": true
}
{- "oauth_enabled": true,
- "password_auth_enabled": true,
- "saml_enabled": true,
- "two_factor_required": true
}
organization_id required | string ID of an organization |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "account_id": "string",
- "create_time": "string",
- "default_governance_user_group_id": "string",
- "organization_id": "string",
- "organization_name": "string",
- "tier": "business",
- "update_time": "string"
}
organization_id required | string ID of an organization |
default_governance_user_group_id | string <= 36 characters Default governance user group ID |
kafka_governance_enabled | boolean Under development - Feature flag for Kafka governance |
name | string <= 128 characters New name of the organization |
tier | string Enum: "business" "personal" New tier for the organization |
{- "default_governance_user_group_id": "string",
- "kafka_governance_enabled": true,
- "name": "string",
- "tier": "business"
}
{- "account_id": "string",
- "create_time": "string",
- "default_governance_user_group_id": "string",
- "organization_id": "string",
- "organization_name": "string",
- "tier": "business",
- "update_time": "string"
}
organization_id required | string ID of an organization |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/projects', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "projects": [
- {
- "account_id": "string",
- "account_name": "string",
- "address_lines": [
- "string"
], - "available_credits": "string",
- "billing_address": "string",
- "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "card_info": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "user_email": "string"
}, - "city": "string",
- "company": "string",
- "country": "string",
- "country_code": "st",
- "default_cloud": "string",
- "end_of_life_extension": {
- "elasticsearch": {
- "eol_date": "string",
- "version": "string"
}
}, - "estimated_balance": "string",
- "estimated_balance_local": "string",
- "features": { },
- "organization_id": "string",
- "payment_method": "string",
- "project_name": "string",
- "state": "string",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "tenant_id": "string",
- "trial_expiration_time": "string",
- "vat_id": "string",
- "zip_code": "string"
}
], - "total_project_count": 0
}
organization_id required | string ID of an organization |
user_email required | string Email address |
action | string Value: "accept" Action to be performed on the invitation |
{- "action": "accept"
}
organization_id required | string ID of an organization |
user_email required | string Email address |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/invitation/%7Buser_email%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
organization_id required | string ID of an organization |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/invitation', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "invitations": [
- {
- "create_time": "string",
- "expiry_time": "string",
- "invited_by": "string",
- "user_email": "string"
}
]
}
organization_id required | string ID of an organization |
user_email required | string User Email |
{- "user_email": "string"
}
organization_name required | string <= 128 characters Organization's name |
primary_billing_group_id | string = 36 characters Billing group ID |
tier required | string Enum: "business" "personal" Tier of the organization |
{- "organization_name": "string",
- "primary_billing_group_id": "stringstringstringstringstringstring",
- "tier": "business"
}
{- "account_id": "string",
- "create_time": "string",
- "default_governance_user_group_id": "string",
- "organization_id": "string",
- "organization_name": "string",
- "tier": "business",
- "update_time": "string"
}
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organizations', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "organizations": [
- {
- "account_id": "string",
- "create_time": "string",
- "default_governance_user_group_id": "string",
- "organization_id": "string",
- "organization_name": "string",
- "tier": "business",
- "update_time": "string"
}
]
}
stripe_token required | string <= 256 characters Credit card Stripe token |
{- "stripe_token": "string"
}
{- "card": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "organization_id": "string",
- "projects": [
- "string"
]
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/card', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "cards": [
- {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "organization_id": "string",
- "projects": [
- "string"
]
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
card_id required | string Credit card ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/card/%7Bcard_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
card_id required | string Credit card ID |
exp_month | integer [ 1 .. 12 ] Expiration month |
exp_year | integer [ 2015 .. 2100 ] Expiration year |
name | string <= 256 characters Name on the credit card |
{- "exp_month": 1,
- "exp_year": 2015,
- "name": "string"
}
{- "card": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "organization_id": "string",
- "projects": [
- "string"
]
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/vpc-peering-connection-types', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "vpc_peering_connection_types": [
- {
- "cloud_name": "string",
- "price_usd": "string",
- "vpc_peering_connection_type": "aws-tgw-vpc-attachment"
}
]
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/alerts', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "alerts": [
- {
- "create_time": "string",
- "event": "string",
- "node_name": "string",
- "project_name": "string",
- "service_name": "string",
- "service_type": "string",
- "severity": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id | string <= 36 characters Account ID |
add_account_owners_admin_access | boolean [DEPRECATED] If account_id is set, grant account owner team admin access to the new project. This flag is ignored, and assumed true. |
address_lines | Array of strings <= 16 items [DEPRECATED] Address lines |
billing_address | string <= 1000 characters DEPRECATED: use split address fields like company, address_lines, zip_code, city and state instead |
billing_currency | string Enum: "AUD" "CAD" "CHF" "DKK" "EUR" "GBP" "JPY" "NOK" "NZD" "SEK" "SGD" "USD" [DEPRECATED] Billing currency |
Array of objects <= 10 items [DEPRECATED] Billing emails | |
billing_extra_text | string <= 1000 characters [DEPRECATED] Extra text to be included in all project invoices |
billing_group_id | string = 36 characters [DEPRECATED] Billing group ID |
card_id | string <= 64 characters [DEPRECATED] Credit card ID |
city | string <= 512 characters [DEPRECATED] Address city |
cloud | string <= 256 characters Target cloud |
company | string <= 128 characters Name of a company |
copy_from_project | string <= 63 characters Project name from which to copy settings to the new project |
copy_tags | boolean Copy tags from the source project. If request contains additional tags, the tags copied from source are updated with them. |
country_code | string <= 2 characters [DEPRECATED] Two letter country code for billing country |
project required | string <= 63 characters Project name |
state | string <= 128 characters [DEPRECATED] Address state |
tags | object Set of resource tags |
Array of objects <= 10 items List of project tech email addresses | |
use_source_project_billing_group | boolean Use the same billing group that is used in source project. |
vat_id | string <= 64 characters [DEPRECATED] EU VAT identification |
zip_code | string <= 32 characters [DEPRECATED] Address zip code |
{- "account_id": "string",
- "add_account_owners_admin_access": true,
- "address_lines": [
- "string"
], - "billing_address": "string",
- "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "card_id": "string",
- "city": "string",
- "cloud": "string",
- "company": "string",
- "copy_from_project": "string",
- "copy_tags": true,
- "country_code": "st",
- "project": "string",
- "state": "string",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "use_source_project_billing_group": true,
- "vat_id": "string",
- "zip_code": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "project": {
- "account_id": "string",
- "account_name": "string",
- "address_lines": [
- "string"
], - "available_credits": "string",
- "billing_address": "string",
- "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "card_info": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "user_email": "string"
}, - "city": "string",
- "company": "string",
- "country": "string",
- "country_code": "st",
- "default_cloud": "string",
- "end_of_life_extension": {
- "elasticsearch": {
- "eol_date": "string",
- "version": "string"
}
}, - "estimated_balance": "string",
- "estimated_balance_local": "string",
- "features": { },
- "organization_id": "string",
- "payment_method": "string",
- "project_name": "string",
- "state": "string",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "tenant_id": "string",
- "trial_expiration_time": "string",
- "vat_id": "string",
- "zip_code": "string"
}
}
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "project_membership": {
- "ANY": "admin"
}, - "project_memberships": {
- "ANY": [
- "string"
]
}, - "projects": [
- {
- "account_id": "string",
- "account_name": "string",
- "address_lines": [
- "string"
], - "available_credits": "string",
- "billing_address": "string",
- "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "card_info": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "user_email": "string"
}, - "city": "string",
- "company": "string",
- "country": "string",
- "country_code": "st",
- "default_cloud": "string",
- "end_of_life_extension": {
- "elasticsearch": {
- "eol_date": "string",
- "version": "string"
}
}, - "estimated_balance": "string",
- "estimated_balance_local": "string",
- "features": { },
- "organization_id": "string",
- "payment_method": "string",
- "project_name": "string",
- "state": "string",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "tenant_id": "string",
- "trial_expiration_time": "string",
- "vat_id": "string",
- "zip_code": "string"
}
]
}
project required | string Project name |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "project": {
- "account_id": "string",
- "account_name": "string",
- "address_lines": [
- "string"
], - "available_credits": "string",
- "billing_address": "string",
- "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "card_info": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "user_email": "string"
}, - "city": "string",
- "company": "string",
- "country": "string",
- "country_code": "st",
- "default_cloud": "string",
- "end_of_life_extension": {
- "elasticsearch": {
- "eol_date": "string",
- "version": "string"
}
}, - "estimated_balance": "string",
- "estimated_balance_local": "string",
- "features": { },
- "organization_id": "string",
- "payment_method": "string",
- "project_name": "string",
- "state": "string",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "tenant_id": "string",
- "trial_expiration_time": "string",
- "vat_id": "string",
- "zip_code": "string"
}
}
project required | string Project name |
account_id | string <= 36 characters Account ID |
add_account_owners_admin_access | boolean [DEPRECATED] If account_id is set, grant account owner team admin access to this project. This flag is ignored and assumed true. |
address_lines | Array of strings <= 16 items [DEPRECATED] Address lines |
billing_address | string <= 1000 characters DEPRECATED: use split address fields like company, address_lines, zip_code, city and state instead |
billing_currency | string Enum: "AUD" "CAD" "CHF" "DKK" "EUR" "GBP" "JPY" "NOK" "NZD" "SEK" "SGD" "USD" [DEPRECATED] Billing currency |
Array of objects <= 10 items [DEPRECATED] List of project billing email addresses | |
billing_extra_text | string <= 1000 characters [DEPRECATED] Extra text to be included in all project invoices, e.g. purchase order or cost center number |
billing_group_id | string = 36 characters [DEPRECATED] Billing group ID |
card_id | string <= 64 characters [DEPRECATED] Credit card ID |
city | string <= 512 characters [DEPRECATED] Address city |
cloud | string <= 256 characters Target cloud |
company | string <= 128 characters Name of a company |
country_code | string <= 2 characters [DEPRECATED] Two letter country code for billing country |
project_name | string <= 63 characters Project name |
state | string <= 128 characters [DEPRECATED] Address state |
tags | object Set of resource tags |
Array of objects <= 10 items List of project tech email addresses | |
vat_id | string <= 64 characters [DEPRECATED] EU VAT Identification Number |
zip_code | string <= 32 characters [DEPRECATED] Address zip code |
{- "account_id": "string",
- "add_account_owners_admin_access": true,
- "address_lines": [
- "string"
], - "billing_address": "string",
- "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "card_id": "string",
- "city": "string",
- "cloud": "string",
- "company": "string",
- "country_code": "st",
- "project_name": "string",
- "state": "string",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "vat_id": "string",
- "zip_code": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "project": {
- "account_id": "string",
- "account_name": "string",
- "address_lines": [
- "string"
], - "available_credits": "string",
- "billing_address": "string",
- "billing_currency": "AUD",
- "billing_emails": [
- {
- "email": "string"
}
], - "billing_extra_text": "string",
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "card_info": {
- "brand": "string",
- "card_id": "string",
- "country": "string",
- "country_code": "st",
- "exp_month": 1,
- "exp_year": 2015,
- "last4": "string",
- "name": "string",
- "user_email": "string"
}, - "city": "string",
- "company": "string",
- "country": "string",
- "country_code": "st",
- "default_cloud": "string",
- "end_of_life_extension": {
- "elasticsearch": {
- "eol_date": "string",
- "version": "string"
}
}, - "estimated_balance": "string",
- "estimated_balance_local": "string",
- "features": { },
- "organization_id": "string",
- "payment_method": "string",
- "project_name": "string",
- "state": "string",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "tenant_id": "string",
- "trial_expiration_time": "string",
- "vat_id": "string",
- "zip_code": "string"
}
}
project required | string Project name |
file_format required | string of the SBOM report |
download_cookie required | string Authentication cookie for file download |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/download-sbom/%7Bfile_format%7D/%7Bdownload_cookie%7D' }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project required | string Project name |
file_format required | string of the SBOM report |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/generate-sbom-download-url/%7Bfile_format%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "download_url": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/events', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "events": [
- {
- "actor": "string",
- "event_desc": "string",
- "event_type": "string",
- "id": "string",
- "service_name": "string",
- "time": "string"
}
], - "message": "string"
}
project required | string Project name |
member_type | string Enum: "admin" "developer" "operator" "read_only" Project member type |
user_email required | string <= 319 characters User email address |
{- "member_type": "admin",
- "user_email": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
invite_verification_code required | string Verification code received via email |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/invite/%7Binvite_verification_code%7D' }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "invite_details": {
- "user_email": "string"
}, - "message": "string"
}
project required | string Project name |
invited_email required | string Email address of user to be invited |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/invite/%7Binvited_email%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/privatelink-availability', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "privatelink_availability": [
- {
- "cloud_name": "string",
- "price_usd": "string"
}
]
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/tags', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "tags": { }
}
project required | string Project name |
tags required | object Set of resource tags |
{- "tags": { }
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
tags required | object Set of resource tags |
{- "tags": { }
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/users', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "group_users": [
- {
- "member_type": "admin",
- "real_name": "string",
- "user_email": "string",
- "user_group_id": "string"
}
], - "invitations": [
- {
- "invite_time": "string",
- "invited_user_email": "string",
- "inviting_user_email": "string",
- "member_type": "admin"
}
], - "message": "string",
- "users": [
- {
- "auth": [
- "string"
], - "billing_contact": true,
- "create_time": "string",
- "member_type": "admin",
- "real_name": "string",
- "team_id": "string",
- "team_name": "string",
- "user_email": "string"
}
]
}
project required | string Project name |
user_email required | string Email address |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/user/%7Buser_email%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
user_email required | string Email address |
member_type required | string Enum: "admin" "developer" "operator" "read_only" Project member type |
{- "member_type": "admin"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
cloud_name required | string <= 256 characters Target cloud |
network_cidr required | string <= 18 characters IPv4 network range CIDR |
required | Array of objects <= 128 items List of peering connection requests for the VPC |
{- "cloud_name": "string",
- "network_cidr": "string",
- "peering_connections": [
- {
- "peer_azure_app_id": "string",
- "peer_azure_tenant_id": "string",
- "peer_cloud_account": "string",
- "peer_region": "string",
- "peer_resource_group": "string",
- "peer_vpc": "string",
- "user_peer_network_cidrs": [
- "string"
]
}
]
}
{- "cloud_name": "string",
- "create_time": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "network_cidr": "string",
- "peering_connections": [
- {
- "create_time": "string",
- "peer_azure_app_id": "string",
- "peer_azure_tenant_id": "string",
- "peer_cloud_account": "string",
- "peer_region": "string",
- "peer_resource_group": "string",
- "peer_vpc": "string",
- "state": "ACTIVE",
- "state_info": {
- "message": "string",
- "type": "string",
- "warnings": [
- {
- "conflicting_aws_account_id": "string",
- "conflicting_aws_vpc_id": "string",
- "conflicting_aws_vpc_peering_connection_id": "string",
- "message": "string",
- "type": "overlapping-peer-vpc-ip-ranges"
}
]
}, - "update_time": "string",
- "user_peer_network_cidrs": [
- "string"
], - "vpc_peering_connection_type": "aws-tgw-vpc-attachment"
}
], - "pending_build_only_peering_connections": "string",
- "project_vpc_id": "stringstringstringstringstringstring",
- "state": "ACTIVE",
- "update_time": "string"
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/vpcs', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "vpcs": [
- {
- "cloud_name": "string",
- "create_time": "string",
- "network_cidr": "string",
- "project_vpc_id": "stringstringstringstringstringstring",
- "state": "ACTIVE",
- "update_time": "string"
}
]
}
project required | string Project name |
project_vpc_id required | string Project VPC ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/vpcs/%7Bproject_vpc_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "cloud_name": "string",
- "create_time": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "network_cidr": "string",
- "peering_connections": [
- {
- "create_time": "string",
- "peer_azure_app_id": "string",
- "peer_azure_tenant_id": "string",
- "peer_cloud_account": "string",
- "peer_region": "string",
- "peer_resource_group": "string",
- "peer_vpc": "string",
- "state": "ACTIVE",
- "state_info": {
- "message": "string",
- "type": "string",
- "warnings": [
- {
- "conflicting_aws_account_id": "string",
- "conflicting_aws_vpc_id": "string",
- "conflicting_aws_vpc_peering_connection_id": "string",
- "message": "string",
- "type": "overlapping-peer-vpc-ip-ranges"
}
]
}, - "update_time": "string",
- "user_peer_network_cidrs": [
- "string"
], - "vpc_peering_connection_type": "aws-tgw-vpc-attachment"
}
], - "pending_build_only_peering_connections": "string",
- "project_vpc_id": "stringstringstringstringstringstring",
- "state": "ACTIVE",
- "update_time": "string"
}
project required | string Project name |
project_vpc_id required | string Project VPC ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/vpcs/%7Bproject_vpc_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "cloud_name": "string",
- "create_time": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "network_cidr": "string",
- "peering_connections": [
- {
- "create_time": "string",
- "peer_azure_app_id": "string",
- "peer_azure_tenant_id": "string",
- "peer_cloud_account": "string",
- "peer_region": "string",
- "peer_resource_group": "string",
- "peer_vpc": "string",
- "state": "ACTIVE",
- "state_info": {
- "message": "string",
- "type": "string",
- "warnings": [
- {
- "conflicting_aws_account_id": "string",
- "conflicting_aws_vpc_id": "string",
- "conflicting_aws_vpc_peering_connection_id": "string",
- "message": "string",
- "type": "overlapping-peer-vpc-ip-ranges"
}
]
}, - "update_time": "string",
- "user_peer_network_cidrs": [
- "string"
], - "vpc_peering_connection_type": "aws-tgw-vpc-attachment"
}
], - "pending_build_only_peering_connections": "string",
- "project_vpc_id": "stringstringstringstringstringstring",
- "state": "ACTIVE",
- "update_time": "string"
}
project required | string Project name |
project_vpc_id required | string Project VPC ID |
peer_azure_app_id | string <= 1024 characters Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet |
peer_azure_tenant_id | string <= 1024 characters Azure tenant id in UUID4 form |
peer_cloud_account required | string <= 1024 characters AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string "upcloud" for UpCloud peering connections |
peer_region | string <= 1024 characters The peer VPC's region on AWS. May be omitted or set to null if the peer is in the same region as the Aiven project VPC. Omit or set to null on GCP, Azure, or UpCloud. |
peer_resource_group | string <= 1024 characters Azure resource group name of the peered VPC |
peer_vpc required | string <= 1024 characters AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID |
user_peer_network_cidrs | Array of strings <= 128 items List of private IPv4 ranges to route through the peering connection |
{- "peer_azure_app_id": "string",
- "peer_azure_tenant_id": "string",
- "peer_cloud_account": "string",
- "peer_region": "string",
- "peer_resource_group": "string",
- "peer_vpc": "string",
- "user_peer_network_cidrs": [
- "string"
]
}
{- "create_time": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "peer_azure_app_id": "string",
- "peer_azure_tenant_id": "string",
- "peer_cloud_account": "string",
- "peer_region": "string",
- "peer_resource_group": "string",
- "peer_vpc": "string",
- "state": "ACTIVE",
- "state_info": {
- "message": "string",
- "type": "string",
- "warnings": [
- {
- "conflicting_aws_account_id": "string",
- "conflicting_aws_vpc_id": "string",
- "conflicting_aws_vpc_peering_connection_id": "string",
- "message": "string",
- "type": "overlapping-peer-vpc-ip-ranges"
}
]
}, - "update_time": "string",
- "user_peer_network_cidrs": [
- "string"
], - "vpc_peering_connection_type": "aws-tgw-vpc-attachment"
}
project required | string Project name |
project_vpc_id required | string Project VPC ID |
peer_cloud_account required | string AWS account ID, Google project name, Azure subscription ID, or string "upcloud" for UpCloud peering connections |
peer_vpc required | string AWS VPC-ID, Google network name, Azure VNet name, or UpCloud VPC ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/vpcs/%7Bproject_vpc_id%7D/peering-connections/peer-accounts/%7Bpeer_cloud_account%7D/peer-vpcs/%7Bpeer_vpc%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "create_time": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "peer_azure_app_id": "string",
- "peer_azure_tenant_id": "string",
- "peer_cloud_account": "string",
- "peer_region": "string",
- "peer_resource_group": "string",
- "peer_vpc": "string",
- "state": "ACTIVE",
- "state_info": {
- "message": "string",
- "type": "string",
- "warnings": [
- {
- "conflicting_aws_account_id": "string",
- "conflicting_aws_vpc_id": "string",
- "conflicting_aws_vpc_peering_connection_id": "string",
- "message": "string",
- "type": "overlapping-peer-vpc-ip-ranges"
}
]
}, - "update_time": "string",
- "user_peer_network_cidrs": [
- "string"
], - "vpc_peering_connection_type": "aws-tgw-vpc-attachment"
}
project required | string Project name |
project_vpc_id required | string Project VPC ID |
Array of objects <= 128 items CIDRs to add using a specific peering connection | |
delete | Array of strings <= 128 items Network CIDRs to remove from the VPC's peering connections' user_peer_network_cidrs |
{- "add": [
- {
- "cidr": "string",
- "peer_cloud_account": "string",
- "peer_resource_group": "string",
- "peer_vpc": "string"
}
], - "delete": [
- "string"
]
}
{- "cloud_name": "string",
- "create_time": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "network_cidr": "string",
- "peering_connections": [
- {
- "create_time": "string",
- "peer_azure_app_id": "string",
- "peer_azure_tenant_id": "string",
- "peer_cloud_account": "string",
- "peer_region": "string",
- "peer_resource_group": "string",
- "peer_vpc": "string",
- "state": "ACTIVE",
- "state_info": {
- "message": "string",
- "type": "string",
- "warnings": [
- {
- "conflicting_aws_account_id": "string",
- "conflicting_aws_vpc_id": "string",
- "conflicting_aws_vpc_peering_connection_id": "string",
- "message": "string",
- "type": "overlapping-peer-vpc-ip-ranges"
}
]
}, - "update_time": "string",
- "user_peer_network_cidrs": [
- "string"
], - "vpc_peering_connection_type": "aws-tgw-vpc-attachment"
}
], - "pending_build_only_peering_connections": "string",
- "project_vpc_id": "stringstringstringstringstringstring",
- "state": "ACTIVE",
- "update_time": "string"
}
project required | string Project name |
project_vpc_id required | string Project VPC ID |
peer_cloud_account required | string AWS account ID, Google project name, Azure subscription ID, or string "upcloud" for UpCloud peering connections |
peer_vpc required | string AWS VPC-ID, Google network name, Azure VNet name, or UpCloud VPC ID |
peer_region required | string AWS region |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/vpcs/%7Bproject_vpc_id%7D/peering-connections/peer-accounts/%7Bpeer_cloud_account%7D/peer-vpcs/%7Bpeer_vpc%7D/peer-regions/%7Bpeer_region%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "create_time": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "peer_azure_app_id": "string",
- "peer_azure_tenant_id": "string",
- "peer_cloud_account": "string",
- "peer_region": "string",
- "peer_resource_group": "string",
- "peer_vpc": "string",
- "state": "ACTIVE",
- "state_info": {
- "message": "string",
- "type": "string",
- "warnings": [
- {
- "conflicting_aws_account_id": "string",
- "conflicting_aws_vpc_id": "string",
- "conflicting_aws_vpc_peering_connection_id": "string",
- "message": "string",
- "type": "overlapping-peer-vpc-ip-ranges"
}
]
}, - "update_time": "string",
- "user_peer_network_cidrs": [
- "string"
], - "vpc_peering_connection_type": "aws-tgw-vpc-attachment"
}
project required | string Project name |
project_vpc_id required | string Project VPC ID |
peer_cloud_account required | string AWS account ID, Google project name, Azure subscription ID, or string "upcloud" for UpCloud peering connections |
peer_resource_group required | string Azure resource group |
peer_vpc required | string AWS VPC-ID, Google network name, Azure VNet name, or UpCloud VPC ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/vpcs/%7Bproject_vpc_id%7D/peering-connections/peer-accounts/%7Bpeer_cloud_account%7D/peer-resource-groups/%7Bpeer_resource_group%7D/peer-vpcs/%7Bpeer_vpc%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "create_time": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "peer_azure_app_id": "string",
- "peer_azure_tenant_id": "string",
- "peer_cloud_account": "string",
- "peer_region": "string",
- "peer_resource_group": "string",
- "peer_vpc": "string",
- "state": "ACTIVE",
- "state_info": {
- "message": "string",
- "type": "string",
- "warnings": [
- {
- "conflicting_aws_account_id": "string",
- "conflicting_aws_vpc_id": "string",
- "conflicting_aws_vpc_peering_connection_id": "string",
- "message": "string",
- "type": "overlapping-peer-vpc-ip-ranges"
}
]
}, - "update_time": "string",
- "user_peer_network_cidrs": [
- "string"
], - "vpc_peering_connection_type": "aws-tgw-vpc-attachment"
}
project required | string Project name |
code required | string <= 1024 characters Credit code |
{- "code": "string"
}
{- "credit": {
- "code": "string",
- "expire_time": "string",
- "remaining_value": "string",
- "start_time": "string",
- "type": "discount",
- "value": "string"
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/credits', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "credits": [
- {
- "code": "string",
- "expire_time": "string",
- "remaining_value": "string",
- "start_time": "string",
- "type": "discount",
- "value": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
invoice_number required | string Invoice number |
download_cookie required | string Authentication cookie for file download |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/invoice/%7Binvoice_number%7D/%7Bdownload_cookie%7D' }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/invoice', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "invoices": [
- {
- "billing_group_id": "stringstringstringstringstringstring",
- "billing_group_name": "string",
- "billing_group_state": "active",
- "currency": "AUD",
- "download_cookie": "string",
- "generated_at": "string",
- "invoice_number": "string",
- "period_begin": "string",
- "period_end": "string",
- "state": "accrual",
- "total_inc_vat": "string",
- "total_vat_zero": "string"
}
], - "message": "string"
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/kms/ca', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "certificate": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
database required | string <= 40 characters Service database name |
{- "database": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
database required | string Database name |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/clickhouse/db/%7Bdatabase%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
limit | integer [ 1 .. 1000 ] Default: 100 Limit for number of results |
offset | integer >= 0 Default: 0 Offset for retrieved results based on sort order |
order_by | string Default: "total_time:desc" Enum: "calls:asc" "calls:desc" "min_time:asc" "min_time:desc" "max_time:asc" "max_time:desc" "mean_time:asc" "mean_time:desc" "p95_time:asc" "p95_time:desc" "stddev_time:asc" "stddev_time:desc" "total_time:asc" "total_time:desc" Order in which to sort retrieved results |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/clickhouse/query/stats', qs: { limit: 'SOME_INTEGER_VALUE', offset: 'SOME_INTEGER_VALUE', order_by: 'SOME_STRING_VALUE' }, headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "queries": [
- {
- "calls": 0,
- "database": "string",
- "max_time": 0,
- "mean_time": 0,
- "min_time": 0,
- "p95_time": 0,
- "query": "string",
- "rows": 0,
- "stddev_time": 0,
- "total_time": 0
}
]
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/clickhouse/tiered-storage/summary', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "current_cost": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "forecasted_cost": "string",
- "forecasted_rate": "string",
- "message": "string",
- "storage_usage_history": {
- "hourly": [
- {
- "estimated_cost": "string",
- "hour_start": "string",
- "peak_stored_bytes": 0
}
]
}, - "total_storage_usage": 0
}
project required | string Project name |
service_name required | string Service name |
application_id required | string Application Id |
deployment_id required | string Deployment Id |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/flink/application/%7Bapplication_id%7D/deployment/%7Bdeployment_id%7D/cancel', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "created_at": "string",
- "created_by": "string",
- "error_msg": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "id": "stringstringstringstringstringstring",
- "job_id": "string",
- "last_savepoint": "string",
- "message": "string",
- "parallelism": 1,
- "restart_enabled": true,
- "starting_savepoint": "string",
- "status": "INITIALIZING",
- "version_id": "stringstringstringstringstringstring"
}
project required | string Project name |
service_name required | string Service name |
object Flink ApplicationVersion | |
name required | string <= 128 characters Application name |
{- "application_version": {
- "sinks": [
- {
- "create_table": "string",
- "integration_id": "stringstringstringstringstringstring"
}
], - "sources": [
- {
- "create_table": "string",
- "integration_id": "stringstringstringstringstringstring"
}
], - "statement": "string"
}, - "name": "string"
}
{- "application_versions": [
- {
- "created_at": "string",
- "created_by": "string",
- "id": "stringstringstringstringstringstring",
- "sinks": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "sources": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "statement": "string",
- "version": 0
}
], - "created_at": "string",
- "created_by": "string",
- "current_deployment": {
- "created_at": "string",
- "created_by": "string",
- "error_msg": "string",
- "id": "stringstringstringstringstringstring",
- "job_id": "string",
- "last_savepoint": "string",
- "parallelism": 1,
- "restart_enabled": true,
- "starting_savepoint": "string",
- "status": "INITIALIZING",
- "version_id": "stringstringstringstringstringstring"
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "id": "stringstringstringstringstringstring",
- "message": "string",
- "name": "string",
- "updated_at": "string",
- "updated_by": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/flink/application', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "applications": [
- {
- "created_at": "string",
- "created_by": "string",
- "id": "stringstringstringstringstringstring",
- "name": "string",
- "updated_at": "string",
- "updated_by": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
application_id required | string Application Id |
parallelism | integer [ 1 .. 128 ] Flink Job parallelism |
restart_enabled | boolean Specifies whether a Flink Job is restarted in case it fails |
starting_savepoint | string [ 1 .. 2048 ] characters Job savepoint |
version_id required | string = 36 characters ApplicationVersion ID |
{- "parallelism": 1,
- "restart_enabled": true,
- "starting_savepoint": "string",
- "version_id": "stringstringstringstringstringstring"
}
{- "created_at": "string",
- "created_by": "string",
- "error_msg": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "id": "stringstringstringstringstringstring",
- "job_id": "string",
- "last_savepoint": "string",
- "message": "string",
- "parallelism": 1,
- "restart_enabled": true,
- "starting_savepoint": "string",
- "status": "INITIALIZING",
- "version_id": "stringstringstringstringstringstring"
}
project required | string Project name |
service_name required | string Service name |
application_id required | string Application Id |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/flink/application/%7Bapplication_id%7D/deployment', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "deployments": [
- {
- "created_at": "string",
- "created_by": "string",
- "error_msg": "string",
- "id": "stringstringstringstringstringstring",
- "job_id": "string",
- "last_savepoint": "string",
- "parallelism": 1,
- "restart_enabled": true,
- "starting_savepoint": "string",
- "status": "INITIALIZING",
- "version_id": "stringstringstringstringstringstring"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
application_id required | string Application Id |
required | Array of objects <= 64 items Sinks |
required | Array of objects <= 64 items Sources |
statement required | string <= 50000 characters Job SQL statement |
{- "sinks": [
- {
- "create_table": "string",
- "integration_id": "stringstringstringstringstringstring"
}
], - "sources": [
- {
- "create_table": "string",
- "integration_id": "stringstringstringstringstringstring"
}
], - "statement": "string"
}
{- "created_at": "string",
- "created_by": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "id": "stringstringstringstringstringstring",
- "message": "string",
- "sinks": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "sources": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "statement": "string",
- "version": 0
}
project required | string Project name |
service_name required | string Service name |
application_id required | string Application Id |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/flink/application/%7Bapplication_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "application_versions": [
- {
- "created_at": "string",
- "created_by": "string",
- "id": "stringstringstringstringstringstring",
- "sinks": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "sources": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "statement": "string",
- "version": 0
}
], - "created_at": "string",
- "created_by": "string",
- "current_deployment": {
- "created_at": "string",
- "created_by": "string",
- "error_msg": "string",
- "id": "stringstringstringstringstringstring",
- "job_id": "string",
- "last_savepoint": "string",
- "parallelism": 1,
- "restart_enabled": true,
- "starting_savepoint": "string",
- "status": "INITIALIZING",
- "version_id": "stringstringstringstringstringstring"
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "id": "stringstringstringstringstringstring",
- "message": "string",
- "name": "string",
- "updated_at": "string",
- "updated_by": "string"
}
project required | string Project name |
service_name required | string Service name |
application_id required | string Application Id |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/flink/application/%7Bapplication_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "application_versions": [
- {
- "created_at": "string",
- "created_by": "string",
- "id": "stringstringstringstringstringstring",
- "sinks": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "sources": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "statement": "string",
- "version": 0
}
], - "created_at": "string",
- "created_by": "string",
- "current_deployment": {
- "created_at": "string",
- "created_by": "string",
- "error_msg": "string",
- "id": "stringstringstringstringstringstring",
- "job_id": "string",
- "last_savepoint": "string",
- "parallelism": 1,
- "restart_enabled": true,
- "starting_savepoint": "string",
- "status": "INITIALIZING",
- "version_id": "stringstringstringstringstringstring"
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "id": "stringstringstringstringstringstring",
- "message": "string",
- "name": "string",
- "updated_at": "string",
- "updated_by": "string"
}
project required | string Project name |
service_name required | string Service name |
application_id required | string Application Id |
name required | string <= 128 characters Application name |
{- "name": "string"
}
{- "application_versions": [
- {
- "created_at": "string",
- "created_by": "string",
- "id": "stringstringstringstringstringstring",
- "sinks": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "sources": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "statement": "string",
- "version": 0
}
], - "created_at": "string",
- "created_by": "string",
- "current_deployment": {
- "created_at": "string",
- "created_by": "string",
- "error_msg": "string",
- "id": "stringstringstringstringstringstring",
- "job_id": "string",
- "last_savepoint": "string",
- "parallelism": 1,
- "restart_enabled": true,
- "starting_savepoint": "string",
- "status": "INITIALIZING",
- "version_id": "stringstringstringstringstringstring"
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "id": "stringstringstringstringstringstring",
- "message": "string",
- "name": "string",
- "updated_at": "string",
- "updated_by": "string"
}
project required | string Project name |
service_name required | string Service name |
application_id required | string Application Id |
deployment_id required | string Deployment Id |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/flink/application/%7Bapplication_id%7D/deployment/%7Bdeployment_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "created_at": "string",
- "created_by": "string",
- "error_msg": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "id": "stringstringstringstringstringstring",
- "job_id": "string",
- "last_savepoint": "string",
- "message": "string",
- "parallelism": 1,
- "restart_enabled": true,
- "starting_savepoint": "string",
- "status": "INITIALIZING",
- "version_id": "stringstringstringstringstringstring"
}
project required | string Project name |
service_name required | string Service name |
application_id required | string Application Id |
deployment_id required | string Deployment Id |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/flink/application/%7Bapplication_id%7D/deployment/%7Bdeployment_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "created_at": "string",
- "created_by": "string",
- "error_msg": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "id": "stringstringstringstringstringstring",
- "job_id": "string",
- "last_savepoint": "string",
- "message": "string",
- "parallelism": 1,
- "restart_enabled": true,
- "starting_savepoint": "string",
- "status": "INITIALIZING",
- "version_id": "stringstringstringstringstringstring"
}
project required | string Project name |
service_name required | string Service name |
application_id required | string Application Id |
application_version_id required | string ApplicationVersion Id |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/flink/application/%7Bapplication_id%7D/version/%7Bapplication_version_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "created_at": "string",
- "created_by": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "id": "stringstringstringstringstringstring",
- "message": "string",
- "sinks": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "sources": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "statement": "string",
- "version": 0
}
project required | string Project name |
service_name required | string Service name |
application_id required | string Application Id |
application_version_id required | string ApplicationVersion Id |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/flink/application/%7Bapplication_id%7D/version/%7Bapplication_version_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "created_at": "string",
- "created_by": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "id": "stringstringstringstringstringstring",
- "message": "string",
- "sinks": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "sources": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "options": { },
- "table_id": "stringstringstringstringstringstring",
- "table_name": "string"
}
], - "statement": "string",
- "version": 0
}
project required | string Project name |
service_name required | string Service name |
job_id required | string Job Id |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/flink/job/%7Bjob_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "duration": 0,
- "end\-time": 0,
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "isStoppable": true,
- "jid": "string",
- "maxParallelism": 0,
- "message": "string",
- "name": "string",
- "now": 0,
- "plan": { },
- "start\-time": 0,
- "state": "INITIALIZING",
- "status\-counts": {
- "CANCELED": 0,
- "CANCELING": 0,
- "CREATED": 0,
- "DEPLOYING": 0,
- "FAILED": 0,
- "FINISHED": 0,
- "INITIALIZING": 0,
- "RECONCILING": 0,
- "RUNNING": 0,
- "SCHEDULED": 0
}, - "timestamps": { },
- "vertices": [
- { }
]
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/flink/job', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "jobs": [
- {
- "id": "string",
- "status": "INITIALIZING"
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/flink/overview', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "flink\-commit": "string",
- "flink\-version": "string",
- "jobs\-cancelled": 0,
- "jobs\-failed": 0,
- "jobs\-finished": 0,
- "jobs\-running": 0,
- "message": "string",
- "slots\-available": 0,
- "slots\-total": 0,
- "taskmanagers": 0
}
project required | string Project name |
service_name required | string Service name |
application_id required | string Application Id |
deployment_id required | string Deployment Id |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/flink/application/%7Bapplication_id%7D/deployment/%7Bdeployment_id%7D/stop', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "created_at": "string",
- "created_by": "string",
- "error_msg": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "id": "stringstringstringstringstringstring",
- "job_id": "string",
- "last_savepoint": "string",
- "message": "string",
- "parallelism": 1,
- "restart_enabled": true,
- "starting_savepoint": "string",
- "status": "INITIALIZING",
- "version_id": "stringstringstringstringstringstring"
}
project required | string Project name |
service_name required | string Service name |
application_id required | string Application Id |
required | Array of objects <= 64 items Sinks |
required | Array of objects <= 64 items Sources |
statement | string <= 50000 characters Job SQL statement |
{- "sinks": [
- {
- "create_table": "string",
- "integration_id": "stringstringstringstringstringstring"
}
], - "sources": [
- {
- "create_table": "string",
- "integration_id": "stringstringstringstringstringstring"
}
], - "statement": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "sinks": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "message": "string",
- "options": { },
- "position": {
- "character_number": 0,
- "end_character_number": 0,
- "end_line_number": 0,
- "line_number": 0
}, - "table_name": "string"
}
], - "sources": [
- {
- "columns": [
- {
- "data_type": "string",
- "extras": "string",
- "key": "string",
- "name": "string",
- "nullable": true,
- "watermark": "string"
}
], - "create_table": "string",
- "integration_id": "stringstringstringstringstringstring",
- "message": "string",
- "options": { },
- "position": {
- "character_number": 0,
- "end_character_number": 0,
- "end_line_number": 0,
- "line_number": 0
}, - "table_name": "string"
}
], - "statement": "string",
- "statement_error": {
- "message": "string",
- "position": {
- "character_number": 0,
- "end_character_number": 0,
- "end_line_number": 0,
- "line_number": 0
}
}
}
project required | string Project name |
service_name required | string Service name |
permission required | string Enum: "admin" "read" "readwrite" "write" Kafka permission |
topic required | string [ 1 .. 249 ] characters Topic name pattern |
username required | string [ 1 .. 64 ] characters Username |
{- "permission": "admin",
- "topic": "string",
- "username": "string"
}
{- "acl": [
- {
- "id": "string",
- "permission": "admin",
- "topic": "string",
- "username": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/acl', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "acl": [
- {
- "id": "string",
- "permission": "admin",
- "topic": "string",
- "username": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
kafka_acl_id required | string Kafka ACL ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/acl/%7Bkafka_acl_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "acl": [
- {
- "id": "string",
- "permission": "admin",
- "topic": "string",
- "username": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
connector.class | string <= 1024 characters The Java class for the connector |
name required | string <= 1024 characters Unique name for the connector |
{- "connector.class": "string",
- "name": "string"
}
{- "connector": {
- "config": {
- "connector.class": "string",
- "name": "string"
}, - "name": "string",
- "plugin": {
- "author": "string",
- "class": "string",
- "docURL": "string",
- "preview": true,
- "preview_info": "string",
- "title": "string",
- "type": "sink",
- "version": "string"
}, - "tasks": [
- {
- "connector": "string",
- "task": 0
}
]
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/connectors', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "connectors": [
- {
- "config": {
- "connector.class": "string",
- "name": "string"
}, - "name": "string",
- "plugin": {
- "author": "string",
- "class": "string",
- "docURL": "string",
- "preview": true,
- "preview_info": "string",
- "title": "string",
- "type": "sink",
- "version": "string"
}, - "tasks": [
- {
- "connector": "string",
- "task": 0
}
]
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
connector_name required | string Connector name |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/connectors/%7Bconnector_name%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
connector_name required | string Connector name |
connector.class | string <= 1024 characters The Java class for the connector |
name required | string <= 1024 characters Unique name for the connector |
{- "connector.class": "string",
- "name": "string"
}
{- "connector": {
- "config": {
- "connector.class": "string",
- "name": "string"
}, - "name": "string",
- "plugin": {
- "author": "string",
- "class": "string",
- "docURL": "string",
- "preview": true,
- "preview_info": "string",
- "title": "string",
- "type": "sink",
- "version": "string"
}, - "tasks": [
- {
- "connector": "string",
- "task": 0
}
]
}, - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/available-connectors', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "plugins": [
- {
- "author": "string",
- "class": "string",
- "docURL": "string",
- "preview": true,
- "preview_info": "string",
- "title": "string",
- "type": "sink",
- "version": "string"
}
]
}
project required | string Project name |
service_name required | string Service name |
connector_name required | string Connector name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/connector-plugins/%7Bconnector_name%7D/configuration', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "configuration_schema": [
- {
- "default_value": "string",
- "display_name": "string",
- "documentation": "string",
- "group": "string",
- "importance": "LOW",
- "name": "string",
- "order": 0,
- "required": true,
- "type": "STRING",
- "width": "NONE"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
connector_name required | string Connector name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/connectors/%7Bconnector_name%7D/status', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "status": {
- "state": "FAILED",
- "tasks": [
- {
- "id": 0,
- "state": "FAILED",
- "trace": "string"
}
]
}
}
project required | string Project name |
service_name required | string Service name |
connector_name required | string Connector name |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/connectors/%7Bconnector_name%7D/pause', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
connector_name required | string Connector name |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/connectors/%7Bconnector_name%7D/restart', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
connector_name required | string Connector name |
task_id required | string Service task |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/connectors/%7Bconnector_name%7D/tasks/%7Btask_id%7D/restart', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
connector_name required | string Connector name |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/connectors/%7Bconnector_name%7D/resume', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
client\-id | string <= 255 characters client-id |
consumer_byte_rate | number [ 0 .. 1073741824 ] consumer network throttle |
producer_byte_rate | number [ 0 .. 1073741824 ] producer network throttle |
request_percentage | number [ 0 .. 100 ] cpu percentage throttle |
user | string <= 64 characters user |
{- "client\-id": "string",
- "consumer_byte_rate": 1073741824,
- "producer_byte_rate": 1073741824,
- "request_percentage": 100,
- "user": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/quota', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/quota', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "quotas": [
- {
- "client\-id": "string",
- "consumer_byte_rate": 1073741824,
- "producer_byte_rate": 1073741824,
- "request_percentage": 100,
- "user": "string"
}
]
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/quota/describe', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "quota": {
- "client\-id": "string",
- "consumer_byte_rate": 1073741824,
- "producer_byte_rate": 1073741824,
- "request_percentage": 100,
- "user": "string"
}
}
Rarely, the data may be not available. In this case, "503 Service Unavailable" is returned and the client should try later.
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/tiered-storage/storage-usage/by-topic', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "storage_usage": { }
}
Rarely, the data may be not available. In this case, "503 Service Unavailable" is returned and the client should try later.
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/tiered-storage/storage-usage/total', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "total_storage_usage": 0
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/tiered-storage/summary', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "current_cost": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "forecasted_cost": "string",
- "forecasted_rate": "string",
- "message": "string",
- "storage_usage_history": {
- "hourly": [
- {
- "estimated_cost": "string",
- "hour_start": "string",
- "peak_stored_bytes": 0
}
]
}, - "total_storage_usage": 0
}
project required | string Project name |
service_name required | string Service name |
cleanup_policy | string Enum: "delete" "compact" "compact,delete" DEPRECATED: use config.cleanup_policy |
object Kafka topic configuration | |
min_insync_replicas | integer >= 1 DEPRECATED: use config.min_insync_replicas |
partitions | integer [ 1 .. 1000000 ] Number of partitions |
replication | integer >= 1 Number of replicas |
retention_bytes | integer DEPRECATED: use config.retention_bytes |
retention_hours | integer <= 2562047788015 DEPRECATED: use config.retention_ms |
Array of objects [ 0 .. 3 ] items Topic tags | |
topic_name required | string [ 1 .. 249 ] characters Topic name |
{- "cleanup_policy": "delete",
- "config": {
- "cleanup_policy": "delete",
- "compression_type": "snappy",
- "delete_retention_ms": 0,
- "file_delete_delay_ms": 0,
- "flush_messages": 0,
- "flush_ms": 0,
- "index_interval_bytes": 0,
- "local_retention_bytes": 0,
- "local_retention_ms": 0,
- "max_compaction_lag_ms": 0,
- "max_message_bytes": 0,
- "message_downconversion_enable": true,
- "message_format_version": "0.8.0",
- "message_timestamp_difference_max_ms": 0,
- "message_timestamp_type": "CreateTime",
- "min_cleanable_dirty_ratio": 1,
- "min_compaction_lag_ms": 0,
- "min_insync_replicas": 1,
- "preallocate": true,
- "remote_storage_enable": true,
- "retention_bytes": 0,
- "retention_ms": 0,
- "segment_bytes": 14,
- "segment_index_bytes": 0,
- "segment_jitter_ms": 0,
- "segment_ms": 1,
- "unclean_leader_election_enable": true
}, - "min_insync_replicas": 1,
- "partitions": 1,
- "replication": 1,
- "retention_bytes": 0,
- "retention_hours": 2562047788015,
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "topic_name": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/topic', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "topics": [
- {
- "cleanup_policy": "string",
- "min_insync_replicas": 1,
- "partitions": 1,
- "remote_storage_enable": true,
- "replication": 1,
- "retention_bytes": 0,
- "retention_hours": 2562047788015,
- "state": "ACTIVE",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "topic_name": "string"
}
]
}
project required | string Project name |
service_name required | string Service name |
topic_name required | string Kafka topic name |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/topic/%7Btopic_name%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
topic_name required | string Kafka topic name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/topic/%7Btopic_name%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "topic": {
- "cleanup_policy": "string",
- "config": {
- "cleanup_policy": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": "string"
}, - "compression_type": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": "snappy"
}, - "delete_retention_ms": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "file_delete_delay_ms": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "flush_messages": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "flush_ms": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "index_interval_bytes": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "local_retention_bytes": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "local_retention_ms": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "max_compaction_lag_ms": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "max_message_bytes": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "message_downconversion_enable": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": true
}, - "message_format_version": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": "0.8.0"
}, - "message_timestamp_difference_max_ms": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "message_timestamp_type": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": "CreateTime"
}, - "min_cleanable_dirty_ratio": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 1
}, - "min_compaction_lag_ms": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "min_insync_replicas": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 1
}, - "preallocate": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": true
}, - "remote_storage_enable": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": true
}, - "retention_bytes": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "retention_ms": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "segment_bytes": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 14
}, - "segment_index_bytes": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "segment_jitter_ms": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 0
}, - "segment_ms": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": 1
}, - "unclean_leader_election_enable": {
- "source": "unknown_config",
- "synonyms": [
- {
- "name": "string",
- "source": "unknown_config",
- "value": true
}
], - "value": true
}
}, - "min_insync_replicas": 1,
- "partitions": [
- {
- "consumer_groups": [
- {
- "group_name": "string",
- "offset": 0
}
], - "earliest_offset": 0,
- "isr": 0,
- "latest_offset": 0,
- "partition": 0,
- "remote_size": 0,
- "size": 0
}
], - "replication": 1,
- "retention_bytes": 0,
- "retention_hours": 2562047788015,
- "state": "ACTIVE",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "topic_name": "string"
}
}
project required | string Project name |
service_name required | string Service name |
topic_name required | string Kafka topic name |
object Kafka topic configuration | |
min_insync_replicas | integer >= 1 DEPRECATED: use config.min_insync_replicas |
partitions | integer [ 1 .. 1000000 ] Number of partitions |
replication | integer >= 1 Number of replicas |
retention_bytes | integer DEPRECATED: use config.retention_bytes |
retention_hours | integer <= 2562047788015 DEPRECATED: use config.retention_ms |
Array of objects [ 0 .. 3 ] items Topic tags |
{- "config": {
- "cleanup_policy": "delete",
- "compression_type": "snappy",
- "delete_retention_ms": 0,
- "file_delete_delay_ms": 0,
- "flush_messages": 0,
- "flush_ms": 0,
- "index_interval_bytes": 0,
- "local_retention_bytes": 0,
- "local_retention_ms": 0,
- "max_compaction_lag_ms": 0,
- "max_message_bytes": 0,
- "message_downconversion_enable": true,
- "message_format_version": "0.8.0",
- "message_timestamp_difference_max_ms": 0,
- "message_timestamp_type": "CreateTime",
- "min_cleanable_dirty_ratio": 1,
- "min_compaction_lag_ms": 0,
- "min_insync_replicas": 1,
- "preallocate": true,
- "remote_storage_enable": true,
- "retention_bytes": 0,
- "retention_ms": 0,
- "segment_bytes": 14,
- "segment_index_bytes": 0,
- "segment_jitter_ms": 0,
- "segment_ms": 1,
- "unclean_leader_election_enable": true
}, - "min_insync_replicas": 1,
- "partitions": 1,
- "replication": 1,
- "retention_bytes": 0,
- "retention_hours": 2562047788015,
- "tags": [
- {
- "key": "string",
- "value": "string"
}
]
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
topic_name required | string Kafka topic name |
format | string Enum: "binary" "json" "avro" "protobuf" "jsonschema" The format of consumed messages, which is used to convert messages into a JSON-compatible form. If unspecified, defaults to binary |
max_bytes | integer [ 1024 .. 1000000000 ] The maximum number of bytes of unencoded keys and values that should be included in the response. This provides approximate control over the size of responses and the amount of memory required to store the decoded response. The actual limit will be the minimum of this setting and the server-side configuration consumer.request.max.bytes. Default is unlimited |
partitions required | object Object of desired partition / offset mappings |
timeout | integer [ 3000 .. 40000 ] The maximum total time to wait for messages for a request if the maximum request size has not yet been reached |
{- "format": "binary",
- "max_bytes": 1024,
- "partitions": { },
- "timeout": 3000
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "messages": [
- {
- "key": { },
- "offset": 0,
- "partition": 0,
- "topic": "string",
- "value": { }
}
]
}
project required | string Project name |
service_name required | string Service name |
topic_name required | string Kafka topic name |
format required | string Enum: "binary" "json" "avro" "protobuf" "jsonschema" The format of the content. |
key_schema | string [ 18 .. 2048 ] characters Full schema encoded as a string (e.g. JSON serialized for Avro data) |
key_schema_id | integer [ 1 .. 50000 ] ID returned by a previous request using the same schema. This ID corresponds to the ID of the schema in the registry. |
required | Array of objects <= 32 items List of records to produce to the topic |
value_schema | string [ 18 .. 2048 ] characters Full schema encoded as a string (e.g. JSON serialized for Avro data) |
value_schema_id | integer [ 1 .. 50000 ] ID returned by a previous request using the same schema. This ID corresponds to the ID of the schema in the registry. |
{- "format": "binary",
- "key_schema": "stringstringstring",
- "key_schema_id": 1,
- "records": [
- {
- "key": { },
- "partition": 10000,
- "value": { }
}
], - "value_schema": "stringstringstring",
- "value_schema_id": 1
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "key_schema_id": 0,
- "message": "string",
- "offsets": [
- {
- "error": "string",
- "error_code": 0,
- "offset": 0,
- "partition": 0
}
], - "value_schema_id": 0
}
project required | string Project name |
service_name required | string Service name |
permission required | string Enum: "schema_registry_read" "schema_registry_write" ACL entry for Schema Registry |
resource required | string [ 1 .. 249 ] characters Schema Registry ACL entry resource name pattern |
username required | string [ 1 .. 64 ] characters Username |
{- "permission": "schema_registry_read",
- "resource": "string",
- "username": "string"
}
{- "acl": [
- {
- "id": "string",
- "permission": "schema_registry_read",
- "resource": "string",
- "username": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/schema-registry/acl', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "acl": [
- {
- "id": "string",
- "permission": "schema_registry_read",
- "resource": "string",
- "username": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
schema_registry_acl_id required | string Kafka Schema Registry ACL ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/schema-registry/acl/%7Bschema_registry_acl_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "acl": [
- {
- "id": "string",
- "permission": "schema_registry_read",
- "resource": "string",
- "username": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
subject_name required | string Subject name |
version_id required | string Version Id |
schema required | string <= 1048576 characters Schema |
schemaType | string Enum: "AVRO" "JSON" "PROTOBUF" Schema type |
{- "schema": "string",
- "schemaType": "AVRO"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "is_compatible": true,
- "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/schema/config', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "compatibilityLevel": "BACKWARD",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
compatibility required | string Enum: "BACKWARD" "BACKWARD_TRANSITIVE" "FORWARD" "FORWARD_TRANSITIVE" "FULL" "FULL_TRANSITIVE" "NONE" Configuration |
{- "compatibility": "BACKWARD"
}
{- "compatibility": "BACKWARD",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
schema_id required | string Schema Id |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/schema/schemas/ids/%7Bschema_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
subject_name required | string Subject name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/schema/config/%7Bsubject_name%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "compatibilityLevel": "BACKWARD",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
subject_name required | string Subject name |
compatibility required | string Enum: "BACKWARD" "BACKWARD_TRANSITIVE" "FORWARD" "FORWARD_TRANSITIVE" "FULL" "FULL_TRANSITIVE" "NONE" Configuration |
{- "compatibility": "BACKWARD"
}
{- "compatibility": "BACKWARD",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
subject_name required | string Subject name |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/schema/subjects/%7Bsubject_name%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
subject_name required | string Subject name |
version_id required | string Version Id |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/schema/subjects/%7Bsubject_name%7D/versions/%7Bversion_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
subject_name required | string Subject name |
version_id required | string Version Id |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/schema/subjects/%7Bsubject_name%7D/versions/%7Bversion_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
subject_name required | string Subject name |
Array of objects <= 128 items Schema references | |
schema required | string <= 1048576 characters Schema |
schemaType | string Enum: "AVRO" "JSON" "PROTOBUF" Schema type |
{- "references": [
- {
- "name": "string",
- "subject": "string",
- "version": 0
}
], - "schema": "string",
- "schemaType": "AVRO"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "id": 0,
- "message": "string"
}
project required | string Project name |
service_name required | string Service name |
subject_name required | string Subject name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/schema/subjects/%7Bsubject_name%7D/versions', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "versions": [
- 0
]
}
project required | string Project name |
service_name required | string Service name |
subject_name required | string Subject name |
version_id required | string Version Id |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/schema/subjects/%7Bsubject_name%7D/versions/%7Bversion_id%7D/schema', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kafka/schema/subjects', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "subjects": [
- "string"
]
}
project required | string Project name |
service_name required | string Service name |
config_properties_exclude | string <= 2048 characters Topic configuration properties that should not be replicated |
emit_backward_heartbeats_enabled | boolean Emit backward heartbeats enabled |
emit_heartbeats_enabled | boolean Emit heartbeats enabled |
enabled required | boolean Is replication flow enabled |
offset_lag_max | integer >= 0 How out-of-sync a remote partition can be before it is resynced |
offset_syncs_topic_location | string Enum: "source" "target" Offset syncs topic location |
replication_policy_class | string Enum: "org.apache.kafka.connect.mirror.DefaultReplicationPolicy" "org.apache.kafka.connect.mirror.IdentityReplicationPolicy" Replication policy class |
source_cluster required | string <= 128 characters Source cluster alias |
sync_group_offsets_enabled | boolean Sync consumer group offsets |
sync_group_offsets_interval_seconds | integer >= 1 Frequency of consumer group offset sync |
target_cluster required | string <= 128 characters Target cluster alias |
topics | Array of strings <= 8192 items List of topics and/or regular expressions to replicate. Topic names and regular expressions that match topic names that should be replicated. MirrorMaker will replicate these topics if they are not matched by "topics.blacklist". Currently defaults to [".*"]. |
topics.blacklist | string <= 128 characters Topic or topic regular expression matching topic |
{- "config_properties_exclude": "string",
- "emit_backward_heartbeats_enabled": true,
- "emit_heartbeats_enabled": true,
- "enabled": true,
- "offset_lag_max": 0,
- "offset_syncs_topic_location": "source",
- "replication_policy_class": "org.apache.kafka.connect.mirror.DefaultReplicationPolicy",
- "source_cluster": "string",
- "sync_group_offsets_enabled": true,
- "sync_group_offsets_interval_seconds": 1,
- "target_cluster": "string",
- "topics": [
- "string"
], - "topics.blacklist": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/mirrormaker/replication-flows', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "replication_flows": [
- {
- "config_properties_exclude": "string",
- "emit_backward_heartbeats_enabled": true,
- "emit_heartbeats_enabled": true,
- "enabled": true,
- "offset_lag_max": 0,
- "offset_syncs_topic_location": "source",
- "replication_policy_class": "org.apache.kafka.connect.mirror.DefaultReplicationPolicy",
- "replication_progress": 1,
- "source_cluster": "string",
- "sync_group_offsets_enabled": true,
- "sync_group_offsets_interval_seconds": 1,
- "target_cluster": "string",
- "topics": [
- "string"
], - "topics.blacklist": "string"
}
]
}
project required | string Project name |
service_name required | string Service name |
source_cluster required | string Source cluster alias |
target_cluster required | string Target cluster alias |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/mirrormaker/replication-flows/%7Bsource_cluster%7D/%7Btarget_cluster%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
source_cluster required | string Source cluster alias |
target_cluster required | string Target cluster alias |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/mirrormaker/replication-flows/%7Bsource_cluster%7D/%7Btarget_cluster%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "replication_flow": {
- "config_properties_exclude": "string",
- "emit_backward_heartbeats_enabled": true,
- "emit_heartbeats_enabled": true,
- "enabled": true,
- "offset_lag_max": 0,
- "offset_syncs_topic_location": "source",
- "replication_policy_class": "org.apache.kafka.connect.mirror.DefaultReplicationPolicy",
- "replication_progress": 1,
- "source_cluster": "string",
- "sync_group_offsets_enabled": true,
- "sync_group_offsets_interval_seconds": 1,
- "target_cluster": "string",
- "topics": [
- "string"
], - "topics.blacklist": "string"
}
}
project required | string Project name |
service_name required | string Service name |
source_cluster required | string Source cluster alias |
target_cluster required | string Target cluster alias |
config_properties_exclude | string <= 2048 characters Topic configuration properties that should not be replicated |
emit_backward_heartbeats_enabled | boolean Emit backward heartbeats enabled |
emit_heartbeats_enabled | boolean Emit heartbeats enabled |
enabled | boolean Is replication flow enabled |
offset_lag_max | integer >= 0 How out-of-sync a remote partition can be before it is resynced |
offset_syncs_topic_location | string Enum: "source" "target" Offset syncs topic location |
replication_policy_class | string Enum: "org.apache.kafka.connect.mirror.DefaultReplicationPolicy" "org.apache.kafka.connect.mirror.IdentityReplicationPolicy" Replication policy class |
sync_group_offsets_enabled | boolean Sync consumer group offsets |
sync_group_offsets_interval_seconds | integer >= 1 Frequency of consumer group offset sync |
topics | Array of strings <= 8192 items List of topics and/or regular expressions to replicate. Topic names and regular expressions that match topic names that should be replicated. MirrorMaker will replicate these topics if they are not matched by "topics.blacklist". Currently defaults to [".*"]. |
topics.blacklist | string <= 128 characters Topic or topic regular expression matching topic |
{- "config_properties_exclude": "string",
- "emit_backward_heartbeats_enabled": true,
- "emit_heartbeats_enabled": true,
- "enabled": true,
- "offset_lag_max": 0,
- "offset_syncs_topic_location": "source",
- "replication_policy_class": "org.apache.kafka.connect.mirror.DefaultReplicationPolicy",
- "sync_group_offsets_enabled": true,
- "sync_group_offsets_interval_seconds": 1,
- "topics": [
- "string"
], - "topics.blacklist": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "replication_flow": {
- "config_properties_exclude": "string",
- "emit_backward_heartbeats_enabled": true,
- "emit_heartbeats_enabled": true,
- "enabled": true,
- "offset_lag_max": 0,
- "offset_syncs_topic_location": "source",
- "replication_policy_class": "org.apache.kafka.connect.mirror.DefaultReplicationPolicy",
- "replication_progress": 1,
- "source_cluster": "string",
- "sync_group_offsets_enabled": true,
- "sync_group_offsets_interval_seconds": 1,
- "target_cluster": "string",
- "topics": [
- "string"
], - "topics.blacklist": "string"
}
}
project required | string Project name |
service_name required | string Service name |
limit | integer [ 1 .. 5000 ] Limit for number of results |
offset | integer >= 0 Offset for retrieved results based on sort order |
order_by | string <= 256 characters Order in which to sort retrieved results |
{- "limit": 1,
- "offset": 0,
- "order_by": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "queries": [
- {
- "avg_timer_wait": 0,
- "count_star": 0,
- "digest": "string",
- "digest_text": "string",
- "first_seen": "string",
- "last_seen": "string",
- "max_timer_wait": 0,
- "min_timer_wait": 0,
- "quantile_95": 0,
- "quantile_99": 0,
- "quantile_999": 0,
- "query_sample_seen": "string",
- "query_sample_text": "string",
- "query_sample_timer_wait": "string",
- "schema_name": "string",
- "sum_created_tmp_disk_tables": 0,
- "sum_created_tmp_tables": 0,
- "sum_errors": 0,
- "sum_lock_time": 0,
- "sum_no_good_index_used": 0,
- "sum_no_index_used": 0,
- "sum_rows_affected": 0,
- "sum_rows_examined": 0,
- "sum_rows_sent": 0,
- "sum_select_full_join": 0,
- "sum_select_full_range_join": 0,
- "sum_select_range": 0,
- "sum_select_range_check": 0,
- "sum_select_scan": 0,
- "sum_sort_merge_passes": 0,
- "sum_sort_range": 0,
- "sum_sort_rows": 0,
- "sum_sort_scan": 0,
- "sum_timer_wait": 0,
- "sum_warnings": 0
}
]
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/opensearch/acl', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "opensearch_acl_config": {
- "acls": [
- {
- "rules": [
- {
- "index": "string",
- "permission": "deny"
}
], - "username": "string"
}
], - "enabled": true
}
}
project required | string Project name |
service_name required | string Service name |
required | object OpenSearch ACL configuration |
{- "opensearch_acl_config": {
- "acls": [
- {
- "rules": [
- {
- "index": "string",
- "permission": "deny"
}
], - "username": "string"
}
], - "enabled": true
}
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "opensearch_acl_config": {
- "acls": [
- {
- "rules": [
- {
- "index": "string",
- "permission": "deny"
}
], - "username": "string"
}
], - "enabled": true
}
}
project required | string Project name |
service_name required | string Service name |
required | object OpenSearch ACL configuration |
{- "opensearch_acl_config": {
- "acls": [
- {
- "rules": [
- {
- "index": "string",
- "permission": "deny"
}
], - "username": "string"
}
], - "enabled": true
}
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "opensearch_acl_config": {
- "acls": [
- {
- "rules": [
- {
- "index": "string",
- "permission": "deny"
}
], - "username": "string"
}
], - "enabled": true
}
}
project required | string Project name |
service_name required | string Service name |
index_name required | string OpenSearch index name |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/index/%7Bindex_name%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/index', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "indexes": [
- {
- "create_time": "string",
- "docs": 0,
- "health": "green",
- "index_name": "string",
- "number_of_replicas": 0,
- "number_of_shards": 1,
- "read_only_allow_delete": true,
- "replication": {
- "leader_index": "string",
- "leader_project": "string",
- "leader_service": "string"
}, - "size": 0,
- "status": "unknown"
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/opensearch/security', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "security_plugin_admin_enabled": true,
- "security_plugin_available": true,
- "security_plugin_enabled": true
}
project required | string Project name |
service_name required | string Service name |
admin_password required | string [ 8 .. 256 ] characters Current os-sec-admin password |
new_password required | string [ 8 .. 256 ] characters New os-sec-admin password |
{- "admin_password": "stringst",
- "new_password": "stringst"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "security_plugin_admin_enabled": true,
- "security_plugin_available": true,
- "security_plugin_enabled": true
}
project required | string Project name |
service_name required | string Service name |
admin_password required | string [ 8 .. 256 ] characters os-sec-admin password |
{- "admin_password": "stringst"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "security_plugin_admin_enabled": true,
- "security_plugin_available": true,
- "security_plugin_enabled": true
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/pg/available-extensions', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "extensions": [
- {
- "name": "string",
- "versions": [
- "string"
]
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
limit | integer [ 1 .. 5000 ] Limit for number of results |
offset | integer >= 0 Offset for retrieved results based on sort order |
order_by | string <= 256 characters Order in which to sort retrieved results |
{- "limit": 1,
- "offset": 0,
- "order_by": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "queries": [
- {
- "blk_read_time": 0,
- "blk_write_time": 0,
- "calls": 0,
- "database_name": "string",
- "local_blks_dirtied": 0,
- "local_blks_hit": 0,
- "local_blks_read": 0,
- "local_blks_written": 0,
- "max_exec_time": 0,
- "max_plan_time": 0,
- "max_time": 0,
- "mean_exec_time": 0,
- "mean_plan_time": 0,
- "mean_time": 0,
- "min_exec_time": 0,
- "min_plan_time": 0,
- "min_time": 0,
- "query": "string",
- "queryid": 0,
- "rows": 0,
- "shared_blks_dirtied": 0,
- "shared_blks_hit": 0,
- "shared_blks_read": 0,
- "shared_blks_written": 0,
- "stddev_exec_time": 0,
- "stddev_plan_time": 0,
- "stddev_time": 0,
- "temp_blks_read": 0,
- "temp_blks_written": 0,
- "total_exec_time": 0,
- "total_plan_time": 0,
- "total_time": 0,
- "user_name": "string",
- "wal_bytes": "string",
- "wal_fpi": 0,
- "wal_records": 0
}
]
}
DEPRECATED: Use /project/$project/service/$service/pg/query/stats instead
project required | string Project name |
service_name required | string Service name |
limit | integer [ 1 .. 5000 ] Limit for number of results |
offset | integer >= 0 Offset for retrieved results based on sort order |
order_by | string <= 256 characters Order in which to sort retrieved results |
{- "limit": 1,
- "offset": 0,
- "order_by": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "queries": [
- {
- "blk_read_time": 0,
- "blk_write_time": 0,
- "calls": 0,
- "database_name": "string",
- "local_blks_dirtied": 0,
- "local_blks_hit": 0,
- "local_blks_read": 0,
- "local_blks_written": 0,
- "max_exec_time": 0,
- "max_plan_time": 0,
- "max_time": 0,
- "mean_exec_time": 0,
- "mean_plan_time": 0,
- "mean_time": 0,
- "min_exec_time": 0,
- "min_plan_time": 0,
- "min_time": 0,
- "query": "string",
- "queryid": 0,
- "rows": 0,
- "shared_blks_dirtied": 0,
- "shared_blks_hit": 0,
- "shared_blks_read": 0,
- "shared_blks_written": 0,
- "stddev_exec_time": 0,
- "stddev_plan_time": 0,
- "stddev_time": 0,
- "temp_blks_read": 0,
- "temp_blks_written": 0,
- "total_exec_time": 0,
- "total_plan_time": 0,
- "total_time": 0,
- "user_name": "string",
- "wal_bytes": "string",
- "wal_fpi": 0,
- "wal_records": 0
}
]
}
project required | string Project name |
service_name required | string Service name |
database required | string <= 63 characters Service database name |
pool_mode | string Enum: "session" "transaction" "statement" PGBouncer pool mode |
pool_name required | string <= 63 characters Connection pool name |
pool_size | integer [ 1 .. 10000 ] Size of PGBouncer's PostgreSQL side connection pool |
username | string <= 64 characters Service username |
{- "database": "string",
- "pool_mode": "session",
- "pool_name": "string",
- "pool_size": 1,
- "username": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
pool_name required | string PgBouncer connection pool name |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/connection_pool/%7Bpool_name%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
pool_name required | string PgBouncer connection pool name |
database | string <= 63 characters Service database name |
pool_mode | string Enum: "session" "transaction" "statement" PGBouncer pool mode |
pool_size | integer [ 1 .. 10000 ] Size of PGBouncer's PostgreSQL side connection pool |
username | string <= 64 characters Service username |
{- "database": "string",
- "pool_mode": "session",
- "pool_size": 1,
- "username": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service_types', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service_types": {
- "cassandra": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "clickhouse": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "dragonfly": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "elasticsearch": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "flink": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "grafana": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "influxdb": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "kafka": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "kafka_connect": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "kafka_mirrormaker": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "m3aggregator": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "m3db": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "mysql": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "opensearch": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "pg": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "redis": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}
}
}
const request = require('request'); const options = {method: 'GET', url: 'https://api.aiven.io/v1/service_types'}; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service_types": {
- "cassandra": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "clickhouse": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "dragonfly": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "elasticsearch": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "flink": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "grafana": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "influxdb": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "kafka": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "kafka_connect": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "kafka_mirrormaker": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "m3aggregator": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "m3db": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "mysql": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "opensearch": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "pg": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}, - "redis": {
- "default_version": "string",
- "description": "string",
- "latest_available_version": "string",
- "service_plans": [
- {
- "backup_config": {
- "frequent_interval_minutes": 0,
- "frequent_oldest_age_minutes": 0,
- "infrequent_interval_minutes": 0,
- "infrequent_oldest_age_minutes": 0,
- "interval": 0,
- "max_count": 0,
- "recovery_mode": "basic"
}, - "max_memory_percent": 100,
- "node_count": 1,
- "regions": { },
- "service_plan": "string",
- "service_type": "string",
- "shard_count": 1
}
], - "user_config_schema": { }
}
}
}
const request = require('request'); const options = {method: 'GET', url: 'https://api.aiven.io/v1/service_versions'}; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service_versions": [
- {
- "aiven_end_of_life_time": "string",
- "availability_end_time": "string",
- "availability_start_time": "string",
- "end_of_life_help_article_url": "string",
- "major_version": "string",
- "service_type": "string",
- "state": "available",
- "termination_time": "string",
- "upgrade_to_service_type": "string",
- "upgrade_to_version": "string",
- "upstream_end_of_life_time": "string"
}
]
}
tenant required | string Aiven tenant ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/tenants/%7Btenant%7D/pg-available-extensions' }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "pg": [
- {
- "extensions": [
- {
- "name": "string",
- "versions": [
- "string"
]
}
], - "version": "string"
}
]
}
project required | string Project name |
service_name required | string Service name |
limit | integer [ 1 .. 500 ] How many log entries to receive at most |
offset | string <= 128 characters Opaque offset identifier |
sort_order | string Enum: "desc" "asc" Sort order for log messages |
{- "limit": 1,
- "offset": "string",
- "sort_order": "desc"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "first_log_offset": "string",
- "logs": [
- {
- "msg": "string",
- "time": "string",
- "unit": "string"
}
], - "message": "string",
- "offset": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/tags', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "tags": { }
}
project required | string Project name |
service_name required | string Service name |
tags required | object Set of resource tags |
{- "tags": { }
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
tags required | object Set of resource tags |
{- "tags": { }
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/alerts', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "alerts": [
- {
- "create_time": "string",
- "event": "string",
- "node_name": "string",
- "project_name": "string",
- "service_name": "string",
- "service_type": "string",
- "severity": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
period | string Enum: "hour" "day" "week" "month" "year" Metrics time period |
{- "period": "hour"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "metrics": { }
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/backups', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "backups": [
- {
- "additional_regions": [
- {
- "cloud": "string",
- "pause_reason": "string",
- "paused": true,
- "region": "string"
}
], - "backup_name": "string",
- "backup_time": "string",
- "data_size": 0,
- "storage_location": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
pid | integer >= 0 Database server connection ID |
terminate | boolean Request immediate termination instead of soft cancel |
{- "pid": 0,
- "terminate": true
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "success": true
}
project required | string Project name |
cloud | string <= 256 characters Target cloud |
copy_tags | boolean If this is a forked service, copy tags from the source service. If request contains additional tags, the tags copied from source are updated with them. |
disk_space_mb | number Megabytes of disk space for data storage |
group_name | string <= 256 characters Service group name (DEPRECATED: do not use) |
object Automatic maintenance settings | |
plan required | string <= 128 characters Subscription plan |
project_vpc_id | string = 36 characters Project VPC ID |
Array of objects <= 64 items Service integrations to enable for the service. Some integration types affect how a service is created and they must be provided as part of the creation call instead of being defined later. | |
service_name required | string [ 1 .. 64 ] characters Service name |
service_type required | string <= 64 characters Service type code |
static_ips | Array of strings <= 128 items Static IP addresses to associate with the service |
tags | object Set of resource tags |
Array of objects <= 10 items List of service technical email addresses | |
termination_protection | boolean Service is protected against termination and powering off |
user_config | object Service type-specific settings |
{- "cloud": "string",
- "copy_tags": true,
- "disk_space_mb": 0,
- "group_name": "string",
- "maintenance": {
- "dow": "monday",
- "time": "stringst"
}, - "plan": "string",
- "project_vpc_id": "stringstringstringstringstringstring",
- "service_integrations": [
- {
- "dest_endpoint_id": "string",
- "dest_project": "string",
- "dest_service": "string",
- "integration_type": "alertmanager",
- "source_endpoint_id": "string",
- "source_project": "string",
- "source_service": "string",
- "user_config": { }
}
], - "service_name": "string",
- "service_type": "string",
- "static_ips": [
- "string"
], - "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "termination_protection": true,
- "user_config": { }
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service": {
- "acl": [
- {
- "id": "string",
- "permission": "admin",
- "topic": "string",
- "username": "string"
}
], - "backups": [
- {
- "additional_regions": [
- {
- "cloud": "string",
- "pause_reason": "string",
- "paused": true,
- "region": "string"
}
], - "backup_name": "string",
- "backup_time": "string",
- "data_size": 0,
- "storage_location": "string"
}
], - "cloud_description": "string",
- "cloud_name": "string",
- "components": [
- {
- "component": "string",
- "host": "string",
- "kafka_authentication_method": "certificate",
- "path": "string",
- "port": 65535,
- "privatelink_connection_id": "string",
- "route": "dynamic",
- "ssl": true,
- "usage": "primary"
}
], - "connection_info": { },
- "connection_pools": [
- {
- "connection_uri": "string",
- "database": "string",
- "pool_mode": "session",
- "pool_name": "string",
- "pool_size": 1,
- "username": "string"
}
], - "create_time": "string",
- "databases": [
- "string"
], - "disk_space_mb": 0,
- "features": { },
- "group_list": [
- "string"
], - "maintenance": {
- "dow": "monday",
- "time": "stringst",
- "updates": [
- {
- "deadline": "string",
- "description": "string",
- "start_after": "string",
- "start_at": "string"
}
]
}, - "metadata": { },
- "node_count": 0,
- "node_cpu_count": 0,
- "node_memory_mb": 0,
- "node_states": [
- {
- "name": "string",
- "progress_updates": [
- {
- "completed": true,
- "current": 0,
- "max": 0,
- "min": 0,
- "phase": "prepare",
- "unit": "binlogs"
}
], - "role": "master",
- "shard": {
- "name": "string",
- "position": 0
}, - "state": "leaving"
}
], - "plan": "string",
- "project_vpc_id": "stringstringstringstringstringstring",
- "schema_registry_acl": [
- {
- "id": "string",
- "permission": "schema_registry_read",
- "resource": "string",
- "username": "string"
}
], - "service_integrations": [
- {
- "active": true,
- "description": "string",
- "dest_endpoint": "string",
- "dest_endpoint_id": "string",
- "dest_project": "string",
- "dest_service": "string",
- "dest_service_type": "string",
- "enabled": true,
- "integration_status": {
- "state": {
- "errors": [
- "string"
], - "likely_error_cause": "null",
- "nodes": { },
- "status": "failed"
}, - "status_user_desc": "string"
}, - "integration_type": "string",
- "service_integration_id": "string",
- "source_endpoint": "string",
- "source_endpoint_id": "string",
- "source_project": "string",
- "source_service": "string",
- "source_service_type": "string",
- "user_config": { }
}
], - "service_name": "string",
- "service_notifications": [
- {
- "level": "notice",
- "message": "string",
- "metadata": {
- "end_of_life_help_article_url": "string",
- "end_of_life_policy_url": "string",
- "service_end_of_life_time": "string",
- "upgrade_to_service_type": "string",
- "upgrade_to_version": "string"
}, - "type": "service_end_of_life"
}
], - "service_type": "string",
- "service_type_description": "string",
- "service_uri": "string",
- "service_uri_params": { },
- "state": "POWEROFF",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "termination_protection": true,
- "topics": [
- {
- "cleanup_policy": "string",
- "min_insync_replicas": 1,
- "partitions": 1,
- "replication": 1,
- "retention_bytes": 0,
- "retention_hours": 2562047788015,
- "state": "ACTIVE",
- "topic_name": "string"
}
], - "update_time": "string",
- "user_config": { },
- "users": [
- {
- "access_cert": "string",
- "access_cert_not_valid_after_time": "string",
- "access_control": {
- "m3_group": "string",
- "pg_allow_replication": true,
- "redis_acl_categories": [
- "string"
], - "redis_acl_channels": [
- "string"
], - "redis_acl_commands": [
- "string"
], - "redis_acl_keys": [
- "string"
]
}, - "access_key": "string",
- "authentication": "null",
- "expiring_cert_not_valid_after_time": "string",
- "password": "string",
- "type": "string",
- "username": "string"
}
]
}
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "services": [
- {
- "acl": [
- {
- "id": "string",
- "permission": "admin",
- "topic": "string",
- "username": "string"
}
], - "backups": [
- {
- "additional_regions": [
- {
- "cloud": "string",
- "pause_reason": "string",
- "paused": true,
- "region": "string"
}
], - "backup_name": "string",
- "backup_time": "string",
- "data_size": 0,
- "storage_location": "string"
}
], - "cloud_description": "string",
- "cloud_name": "string",
- "components": [
- {
- "component": "string",
- "host": "string",
- "kafka_authentication_method": "certificate",
- "path": "string",
- "port": 65535,
- "privatelink_connection_id": "string",
- "route": "dynamic",
- "ssl": true,
- "usage": "primary"
}
], - "connection_info": { },
- "connection_pools": [
- {
- "connection_uri": "string",
- "database": "string",
- "pool_mode": "session",
- "pool_name": "string",
- "pool_size": 1,
- "username": "string"
}
], - "create_time": "string",
- "databases": [
- "string"
], - "disk_space_mb": 0,
- "features": { },
- "group_list": [
- "string"
], - "maintenance": {
- "dow": "monday",
- "time": "stringst",
- "updates": [
- {
- "deadline": "string",
- "description": "string",
- "start_after": "string",
- "start_at": "string"
}
]
}, - "metadata": { },
- "node_count": 0,
- "node_cpu_count": 0,
- "node_memory_mb": 0,
- "node_states": [
- {
- "name": "string",
- "progress_updates": [
- {
- "completed": true,
- "current": 0,
- "max": 0,
- "min": 0,
- "phase": "prepare",
- "unit": "binlogs"
}
], - "role": "master",
- "shard": {
- "name": "string",
- "position": 0
}, - "state": "leaving"
}
], - "plan": "string",
- "project_vpc_id": "stringstringstringstringstringstring",
- "schema_registry_acl": [
- {
- "id": "string",
- "permission": "schema_registry_read",
- "resource": "string",
- "username": "string"
}
], - "service_integrations": [
- {
- "active": true,
- "description": "string",
- "dest_endpoint": "string",
- "dest_endpoint_id": "string",
- "dest_project": "string",
- "dest_service": "string",
- "dest_service_type": "string",
- "enabled": true,
- "integration_status": {
- "state": {
- "errors": [
- "string"
], - "likely_error_cause": "null",
- "nodes": { },
- "status": "failed"
}, - "status_user_desc": "string"
}, - "integration_type": "string",
- "service_integration_id": "string",
- "source_endpoint": "string",
- "source_endpoint_id": "string",
- "source_project": "string",
- "source_service": "string",
- "source_service_type": "string",
- "user_config": { }
}
], - "service_name": "string",
- "service_notifications": [
- {
- "level": "notice",
- "message": "string",
- "metadata": {
- "end_of_life_help_article_url": "string",
- "end_of_life_policy_url": "string",
- "service_end_of_life_time": "string",
- "upgrade_to_service_type": "string",
- "upgrade_to_version": "string"
}, - "type": "service_end_of_life"
}
], - "service_type": "string",
- "service_type_description": "string",
- "service_uri": "string",
- "service_uri_params": { },
- "state": "POWEROFF",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "termination_protection": true,
- "topics": [
- {
- "cleanup_policy": "string",
- "min_insync_replicas": 1,
- "partitions": 1,
- "replication": 1,
- "retention_bytes": 0,
- "retention_hours": 2562047788015,
- "state": "ACTIVE",
- "topic_name": "string"
}
], - "update_time": "string",
- "user_config": { },
- "users": [
- {
- "access_cert": "string",
- "access_cert_not_valid_after_time": "string",
- "access_control": {
- "m3_group": "string",
- "pg_allow_replication": true,
- "redis_acl_categories": [
- "string"
], - "redis_acl_channels": [
- "string"
], - "redis_acl_commands": [
- "string"
], - "redis_acl_keys": [
- "string"
]
}, - "access_key": "string",
- "authentication": "null",
- "expiring_cert_not_valid_after_time": "string",
- "password": "string",
- "type": "string",
- "username": "string"
}
]
}
]
}
project required | string Project name |
service_name required | string Service name |
database required | string <= 40 characters Service database name |
lc_collate | string <= 128 characters Default string sort order (LC_COLLATE) for PostgreSQL database |
lc_ctype | string <= 128 characters Default character classification (LC_CTYPE) for PostgreSQL database |
{- "database": "string",
- "lc_collate": "string",
- "lc_ctype": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/db', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "databases": [
- {
- "database_name": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
dbname required | string DatabaseName |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/db/%7Bdbname%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service": {
- "acl": [
- {
- "id": "string",
- "permission": "admin",
- "topic": "string",
- "username": "string"
}
], - "backups": [
- {
- "additional_regions": [
- {
- "cloud": "string",
- "pause_reason": "string",
- "paused": true,
- "region": "string"
}
], - "backup_name": "string",
- "backup_time": "string",
- "data_size": 0,
- "storage_location": "string"
}
], - "cloud_description": "string",
- "cloud_name": "string",
- "components": [
- {
- "component": "string",
- "host": "string",
- "kafka_authentication_method": "certificate",
- "path": "string",
- "port": 65535,
- "privatelink_connection_id": "string",
- "route": "dynamic",
- "ssl": true,
- "usage": "primary"
}
], - "connection_info": { },
- "connection_pools": [
- {
- "connection_uri": "string",
- "database": "string",
- "pool_mode": "session",
- "pool_name": "string",
- "pool_size": 1,
- "username": "string"
}
], - "create_time": "string",
- "databases": [
- "string"
], - "disk_space_mb": 0,
- "features": { },
- "group_list": [
- "string"
], - "maintenance": {
- "dow": "monday",
- "time": "stringst",
- "updates": [
- {
- "deadline": "string",
- "description": "string",
- "start_after": "string",
- "start_at": "string"
}
]
}, - "metadata": { },
- "node_count": 0,
- "node_cpu_count": 0,
- "node_memory_mb": 0,
- "node_states": [
- {
- "name": "string",
- "progress_updates": [
- {
- "completed": true,
- "current": 0,
- "max": 0,
- "min": 0,
- "phase": "prepare",
- "unit": "binlogs"
}
], - "role": "master",
- "shard": {
- "name": "string",
- "position": 0
}, - "state": "leaving"
}
], - "plan": "string",
- "project_vpc_id": "stringstringstringstringstringstring",
- "schema_registry_acl": [
- {
- "id": "string",
- "permission": "schema_registry_read",
- "resource": "string",
- "username": "string"
}
], - "service_integrations": [
- {
- "active": true,
- "description": "string",
- "dest_endpoint": "string",
- "dest_endpoint_id": "string",
- "dest_project": "string",
- "dest_service": "string",
- "dest_service_type": "string",
- "enabled": true,
- "integration_status": {
- "state": {
- "errors": [
- "string"
], - "likely_error_cause": "null",
- "nodes": { },
- "status": "failed"
}, - "status_user_desc": "string"
}, - "integration_type": "string",
- "service_integration_id": "string",
- "source_endpoint": "string",
- "source_endpoint_id": "string",
- "source_project": "string",
- "source_service": "string",
- "source_service_type": "string",
- "user_config": { }
}
], - "service_name": "string",
- "service_notifications": [
- {
- "level": "notice",
- "message": "string",
- "metadata": {
- "end_of_life_help_article_url": "string",
- "end_of_life_policy_url": "string",
- "service_end_of_life_time": "string",
- "upgrade_to_service_type": "string",
- "upgrade_to_version": "string"
}, - "type": "service_end_of_life"
}
], - "service_type": "string",
- "service_type_description": "string",
- "service_uri": "string",
- "service_uri_params": { },
- "state": "POWEROFF",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "termination_protection": true,
- "topics": [
- {
- "cleanup_policy": "string",
- "min_insync_replicas": 1,
- "partitions": 1,
- "replication": 1,
- "retention_bytes": 0,
- "retention_hours": 2562047788015,
- "state": "ACTIVE",
- "topic_name": "string"
}
], - "update_time": "string",
- "user_config": { },
- "users": [
- {
- "access_cert": "string",
- "access_cert_not_valid_after_time": "string",
- "access_control": {
- "m3_group": "string",
- "pg_allow_replication": true,
- "redis_acl_categories": [
- "string"
], - "redis_acl_channels": [
- "string"
], - "redis_acl_commands": [
- "string"
], - "redis_acl_keys": [
- "string"
]
}, - "access_key": "string",
- "authentication": "null",
- "expiring_cert_not_valid_after_time": "string",
- "password": "string",
- "type": "string",
- "username": "string"
}
]
}
}
project required | string Project name |
service_name required | string Service name |
allow_unclean_poweroff | boolean Default: true Allows or disallows powering off a service if some WAL segments are not available for a future restoration of the service, which might result in data loss when powering the service back on |
cloud | string <= 256 characters Target cloud |
disk_space_mb | number Megabytes of disk space for data storage |
group_name | string <= 256 characters Service group name (DEPRECATED: do not use) |
karapace | boolean Switch the service to use Karapace for schema registry and REST proxy |
object Automatic maintenance settings | |
plan | string <= 128 characters Subscription plan |
powered | boolean Power-on the service (true) or power-off (false) |
project_vpc_id | string = 36 characters Project VPC ID |
schema_registry_authz | boolean Enable or disable Schema Registry authorization |
Array of objects <= 10 items List of service technical email addresses | |
termination_protection | boolean Service is protected against termination and powering off |
user_config | object Service type-specific settings |
{- "cloud": "string",
- "disk_space_mb": 0,
- "group_name": "string",
- "karapace": true,
- "maintenance": {
- "dow": "monday",
- "time": "stringst"
}, - "plan": "string",
- "powered": true,
- "project_vpc_id": "stringstringstringstringstringstring",
- "schema_registry_authz": true,
- "tech_emails": [
- {
- "email": "string"
}
], - "termination_protection": true,
- "user_config": { }
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service": {
- "acl": [
- {
- "id": "string",
- "permission": "admin",
- "topic": "string",
- "username": "string"
}
], - "backups": [
- {
- "additional_regions": [
- {
- "cloud": "string",
- "pause_reason": "string",
- "paused": true,
- "region": "string"
}
], - "backup_name": "string",
- "backup_time": "string",
- "data_size": 0,
- "storage_location": "string"
}
], - "cloud_description": "string",
- "cloud_name": "string",
- "components": [
- {
- "component": "string",
- "host": "string",
- "kafka_authentication_method": "certificate",
- "path": "string",
- "port": 65535,
- "privatelink_connection_id": "string",
- "route": "dynamic",
- "ssl": true,
- "usage": "primary"
}
], - "connection_info": { },
- "connection_pools": [
- {
- "connection_uri": "string",
- "database": "string",
- "pool_mode": "session",
- "pool_name": "string",
- "pool_size": 1,
- "username": "string"
}
], - "create_time": "string",
- "databases": [
- "string"
], - "disk_space_mb": 0,
- "features": { },
- "group_list": [
- "string"
], - "maintenance": {
- "dow": "monday",
- "time": "stringst",
- "updates": [
- {
- "deadline": "string",
- "description": "string",
- "start_after": "string",
- "start_at": "string"
}
]
}, - "metadata": { },
- "node_count": 0,
- "node_cpu_count": 0,
- "node_memory_mb": 0,
- "node_states": [
- {
- "name": "string",
- "progress_updates": [
- {
- "completed": true,
- "current": 0,
- "max": 0,
- "min": 0,
- "phase": "prepare",
- "unit": "binlogs"
}
], - "role": "master",
- "shard": {
- "name": "string",
- "position": 0
}, - "state": "leaving"
}
], - "plan": "string",
- "project_vpc_id": "stringstringstringstringstringstring",
- "schema_registry_acl": [
- {
- "id": "string",
- "permission": "schema_registry_read",
- "resource": "string",
- "username": "string"
}
], - "service_integrations": [
- {
- "active": true,
- "description": "string",
- "dest_endpoint": "string",
- "dest_endpoint_id": "string",
- "dest_project": "string",
- "dest_service": "string",
- "dest_service_type": "string",
- "enabled": true,
- "integration_status": {
- "state": {
- "errors": [
- "string"
], - "likely_error_cause": "null",
- "nodes": { },
- "status": "failed"
}, - "status_user_desc": "string"
}, - "integration_type": "string",
- "service_integration_id": "string",
- "source_endpoint": "string",
- "source_endpoint_id": "string",
- "source_project": "string",
- "source_service": "string",
- "source_service_type": "string",
- "user_config": { }
}
], - "service_name": "string",
- "service_notifications": [
- {
- "level": "notice",
- "message": "string",
- "metadata": {
- "end_of_life_help_article_url": "string",
- "end_of_life_policy_url": "string",
- "service_end_of_life_time": "string",
- "upgrade_to_service_type": "string",
- "upgrade_to_version": "string"
}, - "type": "service_end_of_life"
}
], - "service_type": "string",
- "service_type_description": "string",
- "service_uri": "string",
- "service_uri_params": { },
- "state": "POWEROFF",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "termination_protection": true,
- "topics": [
- {
- "cleanup_policy": "string",
- "min_insync_replicas": 1,
- "partitions": 1,
- "replication": 1,
- "retention_bytes": 0,
- "retention_hours": 2562047788015,
- "state": "ACTIVE",
- "topic_name": "string"
}
], - "update_time": "string",
- "user_config": { },
- "users": [
- {
- "access_cert": "string",
- "access_cert_not_valid_after_time": "string",
- "access_control": {
- "m3_group": "string",
- "pg_allow_replication": true,
- "redis_acl_categories": [
- "string"
], - "redis_acl_channels": [
- "string"
], - "redis_acl_commands": [
- "string"
], - "redis_acl_keys": [
- "string"
]
}, - "access_key": "string",
- "authentication": "null",
- "expiring_cert_not_valid_after_time": "string",
- "password": "string",
- "type": "string",
- "username": "string"
}
]
}
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/enable-writes', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "until": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/migration', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "migration": {
- "error": "string",
- "master_last_io_seconds_ago": 0,
- "master_link_status": "up",
- "method": "",
- "status": "done"
}, - "migration_detail": [
- {
- "dbname": "string",
- "error": "string",
- "method": "",
- "status": "done"
}
]
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/influxdb/stats', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "db_stats": { },
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
ca_name required | string CA name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kms/ca/%7Bca_name%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "certificate": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
keypair_name required | string Keypair name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/kms/keypairs/%7Bkeypair_name%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "certificate": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "key": "string",
- "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'PUT', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/maintenance/start', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
period | string Enum: "hour" "day" "week" "month" "year" Metrics time period |
{- "period": "hour"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "metrics": { }
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/privatelink/aws/connections', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "connections": [
- {
- "dns_name": "string",
- "privatelink_connection_id": "string",
- "state": "pending-user-approval",
- "vpc_endpoint_id": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
principals required | Array of strings [ 1 .. 16 ] items ARN allowlist ARNs of principals allowed connecting to the service |
{- "principals": [
- "string"
]
}
{- "aws_service_id": "string",
- "aws_service_name": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "principals": [
- "string"
], - "state": "creating"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/privatelink/aws', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "aws_service_id": "string",
- "aws_service_name": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "principals": [
- "string"
], - "state": "creating"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/privatelink/aws', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "aws_service_id": "string",
- "aws_service_name": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "principals": [
- "string"
], - "state": "creating"
}
project required | string Project name |
service_name required | string Service name |
principals required | Array of strings [ 1 .. 16 ] items ARN allowlist ARNs of principals allowed connecting to the service |
{- "principals": [
- "string"
]
}
{- "aws_service_id": "string",
- "aws_service_name": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "principals": [
- "string"
], - "state": "creating"
}
project required | string Project name |
service_name required | string Service name |
privatelink_connection_id required | string Privatelink connection ID |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/privatelink/azure/connections/%7Bprivatelink_connection_id%7D/approve', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "private_endpoint_id": "string",
- "privatelink_connection_id": "string",
- "state": "pending-user-approval",
- "user_ip_address": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/privatelink/azure/connections', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "connections": [
- {
- "private_endpoint_id": "string",
- "privatelink_connection_id": "string",
- "state": "pending-user-approval",
- "user_ip_address": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
privatelink_connection_id required | string Privatelink connection ID |
user_ip_address required | string <= 15 characters (Private) IP address of Privatelink endpoint |
{- "user_ip_address": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "private_endpoint_id": "string",
- "privatelink_connection_id": "string",
- "state": "pending-user-approval",
- "user_ip_address": "string"
}
project required | string Project name |
service_name required | string Service name |
user_subscription_ids required | Array of strings <= 16 items Subscription ID allowlist IDs of Azure subscriptions allowed to connect to the service |
{- "user_subscription_ids": [
- "string"
]
}
{- "azure_service_alias": "string",
- "azure_service_id": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "state": "creating",
- "user_subscription_ids": [
- "string"
]
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/privatelink/azure', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "azure_service_alias": "string",
- "azure_service_id": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "state": "creating",
- "user_subscription_ids": [
- "string"
]
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/privatelink/azure', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "azure_service_alias": "string",
- "azure_service_id": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "state": "creating",
- "user_subscription_ids": [
- "string"
]
}
project required | string Project name |
service_name required | string Service name |
user_subscription_ids required | Array of strings <= 16 items Subscription ID allowlist IDs of Azure subscriptions allowed to connect to the service |
{- "user_subscription_ids": [
- "string"
]
}
{- "azure_service_alias": "string",
- "azure_service_id": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "state": "creating",
- "user_subscription_ids": [
- "string"
]
}
project required | string Project name |
service_name required | string Service name |
limit | integer [ 1 .. 5000 ] Limit for number of results |
offset | integer >= 0 Offset for retrieved results based on sort order |
order_by | string <= 256 characters Order in which to sort retrieved results |
{- "limit": 1,
- "offset": 0,
- "order_by": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "queries": [
- {
- "active_channel_subscriptions": 0,
- "active_database": "string",
- "active_pattern_matching_channel_subscriptions": 0,
- "application_name": "string",
- "backend_start": "string",
- "backend_type": "string",
- "backend_xid": 0,
- "backend_xmin": 0,
- "client_addr": "string",
- "client_hostname": "string",
- "client_port": 65536,
- "connection_age_seconds": 0,
- "connection_idle_seconds": 0,
- "datid": 0,
- "datname": "string",
- "flags": [
- "string"
], - "flags_raw": "string",
- "id": "string",
- "leader_pid": 0,
- "multi_exec_commands": 0,
- "name": "string",
- "output_buffer": 0,
- "output_buffer_memory": 0,
- "output_list_length": 0,
- "pid": 0,
- "query": "string",
- "query_buffer": 0,
- "query_buffer_free": 0,
- "query_duration": 0,
- "query_id": 0,
- "query_start": "string",
- "state": "string",
- "state_change": "string",
- "usename": "string",
- "usesysid": 0,
- "wait_event": "string",
- "wait_event_type": "string",
- "waiting": true,
- "xact_start": "string"
}
]
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'PUT', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/query/stats/reset', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "queries": [
- { }
]
}
project required | string Project name |
service_name required | string Service name |
object Payload to be used with dataset_import | |
object Payload to be used with migration_check | |
target_version | string Enum: "12" "13" "14" "15" "16" Target version used with upgrade_check |
task_type required | string Enum: "upgrade_check" "migration_check" "dataset_import" Service task type |
{- "dataset_import": {
- "dataset_name": "pagila"
}, - "migration_check": {
- "ignore_dbs": "string",
- "method": "dump",
- "source_project_name": "string",
- "source_service_name": "string",
- "source_service_uri": "string"
}, - "target_version": "12",
- "task_type": "upgrade_check"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "task": {
- "create_time": "string",
- "result": "string",
- "result_codes": [
- {
- "code": "string",
- "dbname": "string"
}
], - "success": true,
- "task_id": "string",
- "task_type": "string"
}
}
project required | string Project name |
service_name required | string Service name |
task_id required | string Service task |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/task/%7Btask_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "task": {
- "create_time": "string",
- "result": "string",
- "result_codes": [
- {
- "code": "string",
- "dbname": "string"
}
], - "success": true,
- "task_id": "string",
- "task_type": "string"
}
}
project required | string Project name |
service_name required | string Service name |
object Service specific access controls for user Service type specific access control rules for user. Currently only used for configuring user ACLs for Redis version 6 and above. | |
authentication | string Enum: "null" "caching_sha2_password" "mysql_native_password" Authentication details |
username required | string <= 64 characters Service username |
{- "access_control": {
- "m3_group": "string",
- "pg_allow_replication": true,
- "redis_acl_categories": [
- "string"
], - "redis_acl_channels": [
- "string"
], - "redis_acl_commands": [
- "string"
], - "redis_acl_keys": [
- "string"
]
}, - "authentication": "null",
- "username": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "user": {
- "access_cert": "string",
- "access_cert_not_valid_after_time": "string",
- "access_control": {
- "m3_group": "string",
- "pg_allow_replication": true,
- "redis_acl_categories": [
- "string"
], - "redis_acl_channels": [
- "string"
], - "redis_acl_commands": [
- "string"
], - "redis_acl_keys": [
- "string"
]
}, - "access_key": "string",
- "authentication": "null",
- "expiring_cert_not_valid_after_time": "string",
- "password": "string",
- "type": "string",
- "username": "string"
}
}
project required | string Project name |
service_name required | string Service name |
service_username required | string Service username |
object Service specific access controls for user Service type specific access control rules for user. Currently only used for configuring user ACLs for Redis version 6 and above. | |
authentication | string Enum: "null" "caching_sha2_password" "mysql_native_password" Authentication details |
new_password | string [ 8 .. 256 ] characters New password |
operation required | string Enum: "acknowledge-renewal" "reset-credentials" "set-access-control" Operation type |
{- "access_control": {
- "m3_group": "string",
- "pg_allow_replication": true,
- "redis_acl_categories": [
- "string"
], - "redis_acl_channels": [
- "string"
], - "redis_acl_commands": [
- "string"
], - "redis_acl_keys": [
- "string"
]
}, - "authentication": "null",
- "new_password": "stringst",
- "operation": "acknowledge-renewal"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service": {
- "acl": [
- {
- "id": "string",
- "permission": "admin",
- "topic": "string",
- "username": "string"
}
], - "backups": [
- {
- "additional_regions": [
- {
- "cloud": "string",
- "pause_reason": "string",
- "paused": true,
- "region": "string"
}
], - "backup_name": "string",
- "backup_time": "string",
- "data_size": 0,
- "storage_location": "string"
}
], - "cloud_description": "string",
- "cloud_name": "string",
- "components": [
- {
- "component": "string",
- "host": "string",
- "kafka_authentication_method": "certificate",
- "path": "string",
- "port": 65535,
- "privatelink_connection_id": "string",
- "route": "dynamic",
- "ssl": true,
- "usage": "primary"
}
], - "connection_info": { },
- "connection_pools": [
- {
- "connection_uri": "string",
- "database": "string",
- "pool_mode": "session",
- "pool_name": "string",
- "pool_size": 1,
- "username": "string"
}
], - "create_time": "string",
- "databases": [
- "string"
], - "disk_space_mb": 0,
- "features": { },
- "group_list": [
- "string"
], - "maintenance": {
- "dow": "monday",
- "time": "stringst",
- "updates": [
- {
- "deadline": "string",
- "description": "string",
- "start_after": "string",
- "start_at": "string"
}
]
}, - "metadata": { },
- "node_count": 0,
- "node_cpu_count": 0,
- "node_memory_mb": 0,
- "node_states": [
- {
- "name": "string",
- "progress_updates": [
- {
- "completed": true,
- "current": 0,
- "max": 0,
- "min": 0,
- "phase": "prepare",
- "unit": "binlogs"
}
], - "role": "master",
- "shard": {
- "name": "string",
- "position": 0
}, - "state": "leaving"
}
], - "plan": "string",
- "project_vpc_id": "stringstringstringstringstringstring",
- "schema_registry_acl": [
- {
- "id": "string",
- "permission": "schema_registry_read",
- "resource": "string",
- "username": "string"
}
], - "service_integrations": [
- {
- "active": true,
- "description": "string",
- "dest_endpoint": "string",
- "dest_endpoint_id": "string",
- "dest_project": "string",
- "dest_service": "string",
- "dest_service_type": "string",
- "enabled": true,
- "integration_status": {
- "state": {
- "errors": [
- "string"
], - "likely_error_cause": "null",
- "nodes": { },
- "status": "failed"
}, - "status_user_desc": "string"
}, - "integration_type": "string",
- "service_integration_id": "string",
- "source_endpoint": "string",
- "source_endpoint_id": "string",
- "source_project": "string",
- "source_service": "string",
- "source_service_type": "string",
- "user_config": { }
}
], - "service_name": "string",
- "service_notifications": [
- {
- "level": "notice",
- "message": "string",
- "metadata": {
- "end_of_life_help_article_url": "string",
- "end_of_life_policy_url": "string",
- "service_end_of_life_time": "string",
- "upgrade_to_service_type": "string",
- "upgrade_to_version": "string"
}, - "type": "service_end_of_life"
}
], - "service_type": "string",
- "service_type_description": "string",
- "service_uri": "string",
- "service_uri_params": { },
- "state": "POWEROFF",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "termination_protection": true,
- "topics": [
- {
- "cleanup_policy": "string",
- "min_insync_replicas": 1,
- "partitions": 1,
- "replication": 1,
- "retention_bytes": 0,
- "retention_hours": 2562047788015,
- "state": "ACTIVE",
- "topic_name": "string"
}
], - "update_time": "string",
- "user_config": { },
- "users": [
- {
- "access_cert": "string",
- "access_cert_not_valid_after_time": "string",
- "access_control": {
- "m3_group": "string",
- "pg_allow_replication": true,
- "redis_acl_categories": [
- "string"
], - "redis_acl_channels": [
- "string"
], - "redis_acl_commands": [
- "string"
], - "redis_acl_keys": [
- "string"
]
}, - "access_key": "string",
- "authentication": "null",
- "expiring_cert_not_valid_after_time": "string",
- "password": "string",
- "type": "string",
- "username": "string"
}
]
}
}
project required | string Project name |
service_name required | string Service name |
service_username required | string Service username |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/user/%7Bservice_username%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
service_username required | string Service username |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/user/%7Bservice_username%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "user": {
- "access_cert": "string",
- "access_cert_not_valid_after_time": "string",
- "access_control": {
- "m3_group": "string",
- "pg_allow_replication": true,
- "redis_acl_categories": [
- "string"
], - "redis_acl_channels": [
- "string"
], - "redis_acl_commands": [
- "string"
], - "redis_acl_keys": [
- "string"
]
}, - "access_key": "string",
- "authentication": "null",
- "expiring_cert_not_valid_after_time": "string",
- "password": "string",
- "type": "string",
- "username": "string"
}
}
project required | string Project name |
service_name required | string Service name |
service_username required | string Service username |
const request = require('request'); const options = { method: 'PUT', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/user/%7Bservice_username%7D/credentials/reset', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service": {
- "acl": [
- {
- "id": "string",
- "permission": "admin",
- "topic": "string",
- "username": "string"
}
], - "backups": [
- {
- "additional_regions": [
- {
- "cloud": "string",
- "pause_reason": "string",
- "paused": true,
- "region": "string"
}
], - "backup_name": "string",
- "backup_time": "string",
- "data_size": 0,
- "storage_location": "string"
}
], - "cloud_description": "string",
- "cloud_name": "string",
- "components": [
- {
- "component": "string",
- "host": "string",
- "kafka_authentication_method": "certificate",
- "path": "string",
- "port": 65535,
- "privatelink_connection_id": "string",
- "route": "dynamic",
- "ssl": true,
- "usage": "primary"
}
], - "connection_info": { },
- "connection_pools": [
- {
- "connection_uri": "string",
- "database": "string",
- "pool_mode": "session",
- "pool_name": "string",
- "pool_size": 1,
- "username": "string"
}
], - "create_time": "string",
- "databases": [
- "string"
], - "disk_space_mb": 0,
- "features": { },
- "group_list": [
- "string"
], - "maintenance": {
- "dow": "monday",
- "time": "stringst",
- "updates": [
- {
- "deadline": "string",
- "description": "string",
- "start_after": "string",
- "start_at": "string"
}
]
}, - "metadata": { },
- "node_count": 0,
- "node_cpu_count": 0,
- "node_memory_mb": 0,
- "node_states": [
- {
- "name": "string",
- "progress_updates": [
- {
- "completed": true,
- "current": 0,
- "max": 0,
- "min": 0,
- "phase": "prepare",
- "unit": "binlogs"
}
], - "role": "master",
- "shard": {
- "name": "string",
- "position": 0
}, - "state": "leaving"
}
], - "plan": "string",
- "project_vpc_id": "stringstringstringstringstringstring",
- "schema_registry_acl": [
- {
- "id": "string",
- "permission": "schema_registry_read",
- "resource": "string",
- "username": "string"
}
], - "service_integrations": [
- {
- "active": true,
- "description": "string",
- "dest_endpoint": "string",
- "dest_endpoint_id": "string",
- "dest_project": "string",
- "dest_service": "string",
- "dest_service_type": "string",
- "enabled": true,
- "integration_status": {
- "state": {
- "errors": [
- "string"
], - "likely_error_cause": "null",
- "nodes": { },
- "status": "failed"
}, - "status_user_desc": "string"
}, - "integration_type": "string",
- "service_integration_id": "string",
- "source_endpoint": "string",
- "source_endpoint_id": "string",
- "source_project": "string",
- "source_service": "string",
- "source_service_type": "string",
- "user_config": { }
}
], - "service_name": "string",
- "service_notifications": [
- {
- "level": "notice",
- "message": "string",
- "metadata": {
- "end_of_life_help_article_url": "string",
- "end_of_life_policy_url": "string",
- "service_end_of_life_time": "string",
- "upgrade_to_service_type": "string",
- "upgrade_to_version": "string"
}, - "type": "service_end_of_life"
}
], - "service_type": "string",
- "service_type_description": "string",
- "service_uri": "string",
- "service_uri_params": { },
- "state": "POWEROFF",
- "tags": { },
- "tech_emails": [
- {
- "email": "string"
}
], - "termination_protection": true,
- "topics": [
- {
- "cleanup_policy": "string",
- "min_insync_replicas": 1,
- "partitions": 1,
- "replication": 1,
- "retention_bytes": 0,
- "retention_hours": 2562047788015,
- "state": "ACTIVE",
- "topic_name": "string"
}
], - "update_time": "string",
- "user_config": { },
- "users": [
- {
- "access_cert": "string",
- "access_cert_not_valid_after_time": "string",
- "access_control": {
- "m3_group": "string",
- "pg_allow_replication": true,
- "redis_acl_categories": [
- "string"
], - "redis_acl_channels": [
- "string"
], - "redis_acl_commands": [
- "string"
], - "redis_acl_keys": [
- "string"
]
}, - "access_key": "string",
- "authentication": "null",
- "expiring_cert_not_valid_after_time": "string",
- "password": "string",
- "type": "string",
- "username": "string"
}
]
}
}
project required | string Project name |
dest_endpoint_id | string <= 36 characters Integration destination endpoint ID |
dest_project | string <= 63 characters Destination project name |
dest_service | string <= 64 characters Destination service name |
integration_type required | string Enum: "alertmanager" "autoscaler" "caching" "cassandra_cross_service_cluster" "clickhouse_credentials" "clickhouse_kafka" "clickhouse_postgresql" "dashboard" "datadog" "datasource" "external_aws_cloudwatch_logs" "external_aws_cloudwatch_metrics" "external_elasticsearch_logs" "external_google_cloud_logging" "external_opensearch_logs" "flink" "flink_external_bigquery" "flink_external_kafka" "flink_external_postgresql" "internal_connectivity" "jolokia" "kafka_connect" "kafka_connect_postgresql" "kafka_logs" "kafka_mirrormaker" "logs" "m3aggregator" "m3coordinator" "metrics" "opensearch_cross_cluster_replication" "opensearch_cross_cluster_search" "prometheus" "read_replica" "rsyslog" "schema_registry_proxy" "stresstester" "thanoscompactor" "thanosquery" "thanosstore" "vector" "vmalert" Service integration type |
source_endpoint_id | string <= 36 characters Integration source endpoint ID |
source_project | string <= 63 characters Source project name |
source_service | string <= 64 characters Source service name |
user_config | object Service type-specific settings |
{- "dest_endpoint_id": "string",
- "dest_project": "string",
- "dest_service": "string",
- "integration_type": "alertmanager",
- "source_endpoint_id": "string",
- "source_project": "string",
- "source_service": "string",
- "user_config": { }
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service_integration": {
- "active": true,
- "description": "string",
- "dest_endpoint": "string",
- "dest_endpoint_id": "string",
- "dest_project": "string",
- "dest_service": "string",
- "dest_service_type": "string",
- "enabled": true,
- "integration_status": {
- "state": {
- "errors": [
- "string"
], - "likely_error_cause": "null",
- "nodes": { },
- "status": "failed"
}, - "status_user_desc": "string"
}, - "integration_type": "string",
- "service_integration_id": "string",
- "source_endpoint": "string",
- "source_endpoint_id": "string",
- "source_project": "string",
- "source_service": "string",
- "source_service_type": "string",
- "user_config": { }
}
}
project required | string Project name |
integration_id required | string Integration ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/integration/%7Bintegration_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
integration_id required | string Integration ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/integration/%7Bintegration_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service_integration": {
- "active": true,
- "description": "string",
- "dest_endpoint": "string",
- "dest_endpoint_id": "string",
- "dest_project": "string",
- "dest_service": "string",
- "dest_service_type": "string",
- "enabled": true,
- "integration_status": {
- "state": {
- "errors": [
- "string"
], - "likely_error_cause": "null",
- "nodes": { },
- "status": "failed"
}, - "status_user_desc": "string"
}, - "integration_type": "string",
- "service_integration_id": "string",
- "source_endpoint": "string",
- "source_endpoint_id": "string",
- "source_project": "string",
- "source_service": "string",
- "source_service_type": "string",
- "user_config": { }
}
}
project required | string Project name |
integration_id required | string Integration ID |
user_config required | object Service type-specific settings |
{- "user_config": { }
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service_integration": {
- "active": true,
- "description": "string",
- "dest_endpoint": "string",
- "dest_endpoint_id": "string",
- "dest_project": "string",
- "dest_service": "string",
- "dest_service_type": "string",
- "enabled": true,
- "integration_status": {
- "state": {
- "errors": [
- "string"
], - "likely_error_cause": "null",
- "nodes": { },
- "status": "failed"
}, - "status_user_desc": "string"
}, - "integration_type": "string",
- "service_integration_id": "string",
- "source_endpoint": "string",
- "source_endpoint_id": "string",
- "source_project": "string",
- "source_service": "string",
- "source_service_type": "string",
- "user_config": { }
}
}
project required | string Project name |
endpoint_name required | string [ 1 .. 40 ] characters Integration endpoint name |
endpoint_type required | string Enum: "autoscaler" "datadog" "external_aws_cloudwatch_logs" "external_aws_cloudwatch_metrics" "external_aws_s3" "external_clickhouse" "external_elasticsearch_logs" "external_google_cloud_bigquery" "external_google_cloud_logging" "external_kafka" "external_mysql" "external_opensearch_logs" "external_postgresql" "external_redis" "external_schema_registry" "jolokia" "prometheus" "rsyslog" Service integration endpoint type |
user_config required | object Service type-specific settings |
{- "endpoint_name": "string",
- "endpoint_type": "autoscaler",
- "user_config": { }
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service_integration_endpoint": {
- "endpoint_config": { },
- "endpoint_id": "string",
- "endpoint_name": "string",
- "endpoint_type": "autoscaler",
- "user_config": { }
}
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/integration_endpoint', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service_integration_endpoints": [
- {
- "endpoint_config": { },
- "endpoint_id": "string",
- "endpoint_name": "string",
- "endpoint_type": "autoscaler",
- "user_config": { }
}
]
}
project required | string Project name |
integration_endpoint_id required | string Endpoint ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/integration_endpoint/%7Bintegration_endpoint_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
integration_endpoint_id required | string Endpoint ID |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/integration_endpoint/%7Bintegration_endpoint_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service_integration_endpoint": {
- "endpoint_config": { },
- "endpoint_id": "string",
- "endpoint_name": "string",
- "endpoint_type": "autoscaler",
- "user_config": { }
}
}
project required | string Project name |
integration_endpoint_id required | string Endpoint ID |
user_config required | object Service type-specific settings |
{- "user_config": { }
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service_integration_endpoint": {
- "endpoint_config": { },
- "endpoint_id": "string",
- "endpoint_name": "string",
- "endpoint_type": "autoscaler",
- "user_config": { }
}
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/integration_endpoint_types', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "endpoint_types": [
- {
- "endpoint_type": "string",
- "service_types": [
- "string"
], - "title": "string",
- "user_config_schema": { }
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
project required | string Project name |
service_name required | string Service name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/service/%7Bservice_name%7D/integration', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "service_integrations": [
- {
- "active": true,
- "description": "string",
- "dest_endpoint": "string",
- "dest_endpoint_id": "string",
- "dest_project": "string",
- "dest_service": "string",
- "dest_service_type": "string",
- "enabled": true,
- "integration_status": {
- "state": {
- "errors": [
- "string"
], - "likely_error_cause": "null",
- "nodes": { },
- "status": "failed"
}, - "status_user_desc": "string"
}, - "integration_type": "string",
- "service_integration_id": "string",
- "source_endpoint": "string",
- "source_endpoint_id": "string",
- "source_project": "string",
- "source_service": "string",
- "source_service_type": "string",
- "user_config": { }
}
]
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/integration_types', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "integration_types": [
- {
- "dest_description": "string",
- "dest_service_type": "string",
- "dest_service_types": [
- "string"
], - "integration_type": "string",
- "source_description": "string",
- "source_service_types": [
- "string"
], - "user_config_schema": { }
}
], - "message": "string"
}
project required | string Project name |
static_ip_address_id required | string Static IP address identifier |
service_name required | string [ 1 .. 64 ] characters Service name |
{- "service_name": "string"
}
{- "cloud_name": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "ip_address": "string",
- "message": "string",
- "service_name": "string",
- "state": "creating",
- "static_ip_address_id": "string",
- "termination_protection": true
}
project required | string Project name |
static_ip_address_id required | string Static IP address identifier |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/static-ips/%7Bstatic_ip_address_id%7D/association', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "cloud_name": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "ip_address": "string",
- "message": "string",
- "service_name": "string",
- "state": "creating",
- "static_ip_address_id": "string",
- "termination_protection": true
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/static-ip-availability', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "static_ip_address_availability": [
- {
- "cloud_name": "string",
- "price_usd": "string"
}
]
}
project required | string Project name |
static_ip_address_id required | string Static IP address identifier |
termination_protection | boolean Static IP address is protected against deletion |
{- "termination_protection": true
}
{- "cloud_name": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "ip_address": "string",
- "message": "string",
- "service_name": "string",
- "state": "creating",
- "static_ip_address_id": "string",
- "termination_protection": true
}
project required | string Project name |
cloud_name required | string <= 256 characters Target cloud |
termination_protection | boolean Static IP address is protected against deletion |
{- "cloud_name": "string",
- "termination_protection": true
}
{- "cloud_name": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "ip_address": "string",
- "message": "string",
- "service_name": "string",
- "state": "creating",
- "static_ip_address_id": "string",
- "termination_protection": true
}
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/static-ips', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "static_ips": [
- {
- "cloud_name": "string",
- "ip_address": "string",
- "service_name": "string",
- "state": "creating",
- "static_ip_address_id": "string",
- "termination_protection": true
}
]
}
DEPRECATED: Support tickets have been moved to https://support.aiven.io/.
organization_id required | string ID of an organization |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/tickets', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "tickets": [
- {
- "account_id": "string",
- "create_time": "string",
- "description": "string",
- "followers": [
- {
- "real_name": "string",
- "user_email": "string",
- "user_id": "string"
}
], - "following": true,
- "organization_id": "string",
- "project_name": "string",
- "service_name": "string",
- "severity": "critical",
- "state": "closed",
- "submitter": {
- "real_name": "string",
- "user_email": "string",
- "user_id": "string"
}, - "ticket_id": "string",
- "title": "string",
- "update_time": "string",
- "user_email": "string",
- "user_real_name": "string"
}
]
}
DEPRECATED: Support tickets have been moved to https://support.aiven.io/.
project required | string Project name |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/tickets', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "ticket": {
- "account_id": "string",
- "create_time": "string",
- "description": "string",
- "followers": [
- {
- "real_name": "string",
- "user_email": "string",
- "user_id": "string"
}
], - "following": true,
- "organization_id": "string",
- "project_name": "string",
- "service_name": "string",
- "severity": "critical",
- "state": "closed",
- "submitter": {
- "real_name": "string",
- "user_email": "string",
- "user_id": "string"
}, - "ticket_id": "string",
- "title": "string",
- "update_time": "string",
- "user_email": "string",
- "user_real_name": "string"
}
}
DEPRECATED: Support tickets have been moved to https://support.aiven.io/.
project required | string Project name |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/tickets', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "tickets": [
- {
- "account_id": "string",
- "create_time": "string",
- "description": "string",
- "followers": [
- {
- "real_name": "string",
- "user_email": "string",
- "user_id": "string"
}
], - "following": true,
- "organization_id": "string",
- "project_name": "string",
- "service_name": "string",
- "severity": "critical",
- "state": "closed",
- "submitter": {
- "real_name": "string",
- "user_email": "string",
- "user_id": "string"
}, - "ticket_id": "string",
- "title": "string",
- "update_time": "string",
- "user_email": "string",
- "user_real_name": "string"
}
]
}
DEPRECATED: Support tickets have been moved to https://support.aiven.io/.
project required | string Project name |
ticket_id required | string Ticket ID |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/project/%7Bproject%7D/tickets/%7Bticket_id%7D/invite', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
description required | string <= 1000 characters Name / description of an access token |
extend_when_used | boolean Extend token expiration time when token is used. Only applicable if max_age_seconds is specified. |
max_age_seconds | number [ 600 .. 315360000 ] Time the token remains valid since creation (or since last use if extend_when_used is true) |
scopes | Array of strings <= 100 items Scopes this token is restricted to, if specified |
{- "description": "string",
- "extend_when_used": true,
- "max_age_seconds": 600,
- "scopes": [
- "string"
]
}
{- "create_time": "string",
- "created_manually": true,
- "currently_active": true,
- "description": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "expiry_time": "string",
- "extend_when_used": true,
- "full_token": "string",
- "last_ip": "string",
- "last_used_time": "string",
- "last_user_agent": "string",
- "last_user_agent_human_readable": "string",
- "max_age_seconds": 600,
- "message": "string",
- "scopes": [
- "string"
], - "token_prefix": "string"
}
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/access_token', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "tokens": [
- {
- "create_time": "string",
- "created_manually": true,
- "currently_active": true,
- "description": "string",
- "expiry_time": "string",
- "extend_when_used": true,
- "last_ip": "string",
- "last_used_time": "string",
- "last_user_agent": "string",
- "last_user_agent_human_readable": "string",
- "max_age_seconds": 600,
- "scopes": [
- "string"
], - "token_prefix": "string"
}
]
}
token_prefix required | string Access token prefix |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/access_token/%7Btoken_prefix%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
token_prefix required | string Access token prefix |
description required | string <= 1000 characters Name / description of an access token |
{- "description": "string"
}
{- "create_time": "string",
- "created_manually": true,
- "currently_active": true,
- "description": "string",
- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "expiry_time": "string",
- "extend_when_used": true,
- "last_ip": "string",
- "last_used_time": "string",
- "last_user_agent": "string",
- "last_user_agent_human_readable": "string",
- "max_age_seconds": 600,
- "message": "string",
- "scopes": [
- "string"
], - "token_prefix": "string"
}
new_password required | string <= 256 characters New password |
old_password required | string <= 256 characters User password |
{- "new_password": "string",
- "old_password": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "password_strength": {
- "is_acceptable": true,
- "message": "string",
- "score": 4
}
}
string <= 319 characters User email address | |
password required | string <= 256 characters New password |
real_name | string <= 256 characters User real name |
{- "email": "string",
- "password": "string",
- "real_name": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "password_strength": {
- "is_acceptable": true,
- "message": "string",
- "score": 4
}
}
organization_id required | string ID of an organization |
member_user_id required | string ID of the organization's user |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/user/%7Bmember_user_id%7D/user-groups', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "user_groups": [
- {
- "create_time": "string",
- "description": "string",
- "managed_by_scim": true,
- "update_time": "string",
- "user_group_id": "string",
- "user_group_name": "string"
}
]
}
organization_id required | string ID of an organization |
member_user_id required | string ID of the organization's user |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/user/%7Bmember_user_id%7D/authentication_methods', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "authentication_methods": [
- {
- "is_enabled_2fa": true,
- "last_used_time": "string",
- "local_provider_id": "string",
- "method_id": "string",
- "name": "string",
- "organization_id": "string",
- "remote_provider_id": "string",
- "type": "string",
- "user_email": "string",
- "user_id": "string"
}
]
}
organization_id required | string ID of an organization |
member_user_id required | string ID of the organization's user |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/user/%7Bmember_user_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "message": "string",
- "errors": [
- {
- "message": "string",
- "error_code": "cannot_remove_managed_users_from_organization"
}
]
}
organization_id required | string ID of an organization |
member_user_id required | string ID of the organization's user |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/user/%7Bmember_user_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "is_super_admin": true,
- "join_time": "string",
- "last_activity_time": "string",
- "user_id": "string",
- "user_info": {
- "city": "string",
- "country": "string",
- "create_time": "string",
- "department": "string",
- "is_application_user": true,
- "job_title": "string",
- "managed_by_scim": true,
- "managing_organization_id": "string",
- "real_name": "string",
- "state": "string",
- "user_email": "string"
}
}
organization_id required | string ID of an organization |
member_user_id required | string ID of the organization's user |
city | string City |
country | string Country |
department | string Department |
is_super_admin | boolean Alters super admin state of the organization user |
job_title | string Job Title |
real_name | string <= 256 characters Real Name |
state | string Enum: "active" "deactivated" "deleted" State of the user in the organization |
{- "city": "string",
- "country": "string",
- "department": "string",
- "is_super_admin": true,
- "job_title": "string",
- "real_name": "string",
- "state": "active"
}
{- "is_super_admin": true,
- "join_time": "string",
- "last_activity_time": "string",
- "user_id": "string",
- "user_info": {
- "city": "string",
- "country": "string",
- "create_time": "string",
- "department": "string",
- "is_application_user": true,
- "job_title": "string",
- "managed_by_scim": true,
- "managing_organization_id": "string",
- "real_name": "string",
- "state": "string",
- "user_email": "string"
}
}
organization_id required | string ID of an organization |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/user', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "users": [
- {
- "is_super_admin": true,
- "join_time": "string",
- "last_activity_time": "string",
- "user_id": "string",
- "user_info": {
- "city": "string",
- "country": "string",
- "create_time": "string",
- "department": "string",
- "is_application_user": true,
- "job_title": "string",
- "managed_by_scim": true,
- "managing_organization_id": "string",
- "real_name": "string",
- "state": "string",
- "user_email": "string"
}
}
]
}
organization_id required | string ID of an organization |
member_user_id required | string ID of the organization's user |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/user/%7Bmember_user_id%7D/reset_password', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
organization_id required | string ID of an organization |
member_user_id required | string ID of the organization's user |
token_prefix required | string Access token prefix |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/user/%7Bmember_user_id%7D/access-token/%7Btoken_prefix%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
Returns tokens generated using general authentication methods or authentication methods linked to the organization.
organization_id required | string ID of an organization |
member_user_id required | string ID of the organization's user |
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/organization/%7Borganization_id%7D/user/%7Bmember_user_id%7D/access-tokens', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "tokens": [
- {
- "description": "string",
- "last_ip": "string",
- "last_used_time": "string",
- "last_user_agent": "string",
- "token_prefix": "string"
}
]
}
method required | string <= 32 characters Two-factor authentication method being used, if any |
password required | string <= 256 characters Current password |
{- "method": "string",
- "password": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "method": "string",
- "qrcode": "string",
- "uri": "string"
}
otp required | string <= 6 characters One-time password |
password required | string <= 256 characters Current password |
uri required | string <= 2048 characters URI describing the TOTP |
{- "otp": "string",
- "password": "string",
- "uri": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "method": "string",
- "token": "string"
}
account_id required | string <= 36 characters Account ID |
team_id | string <= 32 characters Team ID |
{- "account_id": "string",
- "team_id": "string"
}
{- "account_invites": [
- {
- "account_id": "string",
- "account_name": "string",
- "create_time": "string",
- "invited_by_user_email": "string",
- "team_id": "string",
- "team_name": "string",
- "user_email": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/me/account/invites', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "account_invites": [
- {
- "account_id": "string",
- "account_name": "string",
- "create_time": "string",
- "invited_by_user_email": "string",
- "team_id": "string",
- "team_name": "string",
- "user_email": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
account_id required | string <= 36 characters Account ID |
team_id required | string <= 32 characters Team ID |
{- "account_id": "string",
- "team_id": "string"
}
{- "account_invites": [
- {
- "account_id": "string",
- "account_name": "string",
- "create_time": "string",
- "invited_by_user_email": "string",
- "team_id": "string",
- "team_name": "string",
- "user_email": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
Authenticate user and return token for following authorizations
email required | string <= 319 characters User email address |
otp | string <= 6 characters One-time password |
password required | string <= 256 characters User password |
{- "email": "string",
- "otp": "string",
- "password": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "return_url": "string",
- "state": "string",
- "token": "string",
- "user_email": "string"
}
Get available user login options
string <= 319 characters User email address |
{- "email": "string"
}
{- "None": [
- { }
], - "action": "azure_oauth",
- "method": "POST",
- "name": "string",
- "redirect_url": "string"
}
user_authentication_method_id required | string User authentication method ID |
const request = require('request'); const options = { method: 'DELETE', url: 'https://api.aiven.io/v1/me/authentication_methods/%7Buser_authentication_method_id%7D', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/me/authentication_methods', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "authentication_methods": [
- {
- "authentication_method_account_id": "string",
- "create_time": "string",
- "currently_active": true,
- "delete_time": "string",
- "last_used_time": "string",
- "method_id": "string",
- "name": "string",
- "public_remote_identity": "string",
- "remote_provider_id": "string",
- "state": "active",
- "update_time": "string",
- "user_email": "string"
}
], - "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
company | string <= 128 characters Name of a company |
country_code | string <= 2 characters Two letter country code for country |
credit_code | string <= 1024 characters Credit code |
email required | string <= 319 characters User email address |
email_communication_categories | Array of strings <= 3 items Categories of email communication enabled for user during signup |
origin | string <= 1024 characters Origin of the user |
password | string <= 256 characters User password |
real_name required | string <= 256 characters User real name |
state | string <= 128 characters Address state |
token | string <= 4096 characters Signup token for single sign-on linking |
{- "company": "string",
- "country_code": "st",
- "credit_code": "string",
- "email": "string",
- "email_communication_categories": [
- "string"
], - "origin": "string",
- "password": "string",
- "real_name": "string",
- "state": "string",
- "token": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "state": "string",
- "token": "string",
- "user": {
- "auth": [
- "string"
], - "city": "string",
- "country": "string",
- "create_time": "string",
- "department": "string",
- "features": { },
- "invitations": [
- {
- "invite_code": "string",
- "invite_time": "string",
- "inviting_user_email": "string",
- "project_name": "string"
}
], - "job_title": "string",
- "managed_by_scim": true,
- "managing_organization_id": "string",
- "project_membership": {
- "ANY": "admin"
}, - "project_memberships": {
- "ANY": [
- "string"
]
}, - "projects": [
- "string"
], - "real_name": "string",
- "state": "string",
- "token_validity_begin": "string",
- "user": "string",
- "user_id": "string"
}, - "user_email": "string"
}
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/me/expire_tokens', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/me', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "user": {
- "auth": [
- "string"
], - "city": "string",
- "country": "string",
- "create_time": "string",
- "department": "string",
- "features": { },
- "intercom": {
- "app_id": "string",
- "hmac": "string"
}, - "invitations": [
- {
- "invite_code": "string",
- "invite_time": "string",
- "inviting_user_email": "string",
- "project_name": "string"
}
], - "job_title": "string",
- "managed_by_scim": true,
- "managing_organization_id": "string",
- "project_membership": {
- "ANY": "admin"
}, - "project_memberships": {
- "ANY": [
- "string"
]
}, - "projects": [
- "string"
], - "real_name": "string",
- "state": "string",
- "token_validity_begin": "string",
- "user": "string",
- "user_id": "string"
}
}
Updates details for the user. Returns user's updated information upon success.
city | string <= 256 characters City |
country | string <= 256 characters Country code ISO 3166-1 alpha-2 |
department | string <= 256 characters Job department |
job_title | string <= 256 characters Job title |
real_name required | string <= 256 characters User real name |
{- "city": "string",
- "country": "string",
- "department": "string",
- "job_title": "string",
- "real_name": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "user": {
- "auth": [
- "string"
], - "city": "string",
- "country": "string",
- "create_time": "string",
- "department": "string",
- "features": { },
- "intercom": {
- "app_id": "string",
- "hmac": "string"
}, - "invitations": [
- {
- "invite_code": "string",
- "invite_time": "string",
- "inviting_user_email": "string",
- "project_name": "string"
}
], - "job_title": "string",
- "managed_by_scim": true,
- "managing_organization_id": "string",
- "project_membership": {
- "ANY": "admin"
}, - "project_memberships": {
- "ANY": [
- "string"
]
}, - "projects": [
- "string"
], - "real_name": "string",
- "state": "string",
- "token_validity_begin": "string",
- "user": "string",
- "user_id": "string"
}
}
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/me/logout', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
Sets a new password for the user. Immediately expires all existing authentication tokens.
new_password required | string <= 256 characters New password |
password required | string <= 256 characters Current password |
{- "new_password": "string",
- "password": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string",
- "token": "string"
}
verification_code required | string Verification code received via email |
new_password required | string <= 256 characters New password |
{- "new_password": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
Request a password reset code to be sent to the user's email address.
email required | string <= 319 characters User email address |
{- "email": "string"
}
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
Confirm user email address after user has received the confirm code via email.
verification_code required | string Verification code received via email |
const request = require('request'); const options = { method: 'POST', url: 'https://api.aiven.io/v1/user/verify_email/%7Bverification_code%7D' }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "invite_details": {
- "user_email": "string"
}, - "message": "string"
}
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/user/credit_code/%7Bcredit_code%7D' }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}
const request = require('request'); const options = { method: 'GET', url: 'https://api.aiven.io/v1/me/referral/validation/%7Breferral_code%7D' }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "errors": [
- {
- "message": "string",
- "more_info": "string",
- "status": 0
}
], - "message": "string"
}