Protocol Documentation

Maximum timeout in seconds.

If set, the method can be retried automatically.

Maximum timeout in seconds. If a timeout is also set on method level, that timeout overrides this timeout.

ID of project to attach the AuditLog to.

ID of the AuditLog to attach.

The ID of this resource. This is a read-only value.

URL of this resource This is a read-only value.

Name of the audit log

Description of the audit log

The creation timestamp of the resource This is a read-only value.

The deletion timestamp of the resource This is a read-only value.

Set when this resource is deleted. This is a read-only value.

Identifier of the user who created this resource. This is a read-only value.

Identifier of the organization that owns this audit log. After creation, this value cannot be changed.

If set, this AuditLog is the default for the organization. This is a read-only value. The default AuditLog for an organization is used to capture audit events from the ArangoGraph Insights Platform. If there is no default AuditLog, audit events from the ArangoGraph Insights Platform are not captured. The default AuditLog is also attached to new projects in the organization.

Destinations that events of this AuditLog should be sent to. Note that there can only be 1 destination of type "cloud".

Type of destination. Possible values are: "cloud", "https-post"

Do not send audit events with these topics to this destination.

Settings for destinations of type "https-post"

Status of this destination (per deployment) This is a read-only value.

Identifier of this destination. This is a read-only value. To ensure matching updates of destinations, include this field in calls to UpdateAuditLog and TestAuditLogHttpsPostDestination.

The number of audit log events this destination has been processed. This number will not include the excluded events, so contain events which are relevant after filtering only.

The number of audit log events this destination has been excluded based on the provided 'excluded_topics' filter.

The number of undeliverable audit log events for this destination. Undeliverable means that they are removed without being successfully processed, retries are not taken into account here.

The bytes of successfull audit log events this destination has been processed.

The bytes of unsuccessfull audit log events this destination has been trying to process. This include retries, however not any filtered events or undeliverable events which are discarded based on retry_period period without being ever sent.

The number of successfull HTTPS posts this destination has been sent. An HTTPS POST request is considered successful when a status code between 200 and 299 is returned. This field is used when the destination type is "https-post" only.

The number of unsuccessfull HTTPS posts this destination has been trying to sent. This field is used when the destination type is "https-post" only.

ID of the deployment that the status applied to (if applicable) The deployment ID of the status is optional, inside the list at most one destination status is allowed to be empty, meaning the ArangoGraph Insights Platform status, all others will be bound to a specific deployment as indicated by this ID.

Set if this destination (for the provided deployment) has errors.

Human readable error message (if any).

The counters of a destination for audit events (for the provided deployment) for today since midnight. The fields inside this message will be reset at midnight UTC. The updated_at timestamp will be used as baseline for the time.

The counters of a destination for audit events (for the provided deployment) for yesterday. The updated_at timestamp will be used as baseline for the time.

Timestamp when this status has been last updated. This is used as baseline for the counters_since_midnight and counters_yesterday fields.

Last known name of the deployment identified by deployment_id (if any). This is a read-only value.

Key of the header

Value of the header This is a write-only value. On read requests, the value is mangled to something like "abc..."

URL of the server to POST to. The scheme of the URL must be "https". The used URLs within a single audit log should be unique.

PEM encoded public key of the CA used to sign the server TLS certificate. This public key will be used to verify the TLS connection provided by the server. If this field is empty, a well known CA is expected.

PEM encoded public key of the client certificate used to make the request.

PEM encoded private key of the client certificate used to make the request. This is a write-only value.

HTTP headers to add to the request. It is allowed to pass multiple headers with the same key.

The period this https-post destination will retry to deliver audit events. Not specifying this value will default to 4 hours, the maximum allowed value is 24 hours. When this time is exceeded for an event this event will be discarded, however newer events will still be delivered.

The ID of this resource. This is a read-only value.

URL of this resource This is a read-only value.

The creation timestamp of the resource This is a read-only value.

The deletion timestamp of the resource This is a read-only value.

Set when this resource is deleted. This is a read-only value.

Identifier of the auditlog that owns this audit log archive. This is a read-only value.

If set, this archive is collecting audit events for a deployment with this ID. Note that the deployment may have already been deleted.

Last known size of this archive in bytes. Note that this field is only update periodically. This is a read-only value.

The timestamp of the last modification of size_in_bytes. This is a read-only value.

If set, this archive is collecting audit events for a deployment in the project with this ID. This is a read-only value.

Last known name of the deployment identified by deployment_id. This is a read-only value.

Last known name of the project identified by project_id. This is a read-only value.

If set, it is safe to delete this archive. It does not mean that the caller has permission to delete the archive. This is a read-only value.

When did the event happen

Topic of the event

ID of the project that the event happened in (if applicable)

ID of the deployment that the event happened in (if applicable)

ID of the server that the event happened in (if applicable)

Instance ID of the server that the event happened in (if applicable)

Sequence number. Must be even increasing for (deployment_id, server_id, instance_id) pairs.

ID of the user that caused the event

Name of database the operation is in (if applicable)

IP address of source of operation (if available)

Authentication details

Free format text describing the event

ID of the AuditLogArchive that contains this event (if applicable)

Verb of the event (if applicable)

The audit log event items.

A cursor is opaq information to be provided by a next call to GetAuditLogEvents, to continue from this point on (meaning after the last item in the provided items). If the string has a non empty value there is (potentially) more data, if the string is empty (""), no more data is available.

Identifier of the topic

If set, this topic is used in audit log events of deployments.

If set, this topic is used in audit log events of the ArangoGraph Insights Platform.

If set, this topic will be excluded by default when adding new destinations.

Identifier of the audit log archive to delete events from.

Remove events created before this timestamp. Note that this timestamp will be rounded down to the nearest hour.

Identifier of the audit log to request events for. This field is optional when an auditlogarchive_id is specified, however if specified, it should match.

If set, include only events from this AuditLogArchive. If this identifier is provided the auditlog_id is optional.

Request events created at or after this timestamp. This is an optional field.

Request events created before this timestamp. This is an optional field.

If non-empty, only request events with one of these topics.

If non-empty, leave out events with one of these topics. If a topic is specified in included_topics as well as excluded_topics, events of that topic will not be included in the results.

Limit the number of audit log events. Defaults to 0, meaning no limit.

A cursor is opaq information provided by a previous call to GetAuditLogEvents, to continue from that point on.

Identifier of the audit log to request the audit log archives for.

If set, the result includes all audit log archives, including those who set to deleted, however are not removed from the system currently. If not set, only audit log archives not indicated as deleted are returned.

If set, the results will only include archive items which belong to the deployment identified by this ID.

If set, the results will only include archive items which belong to no deployment. Setting this field and specifying a deployment_id will result in an empty list.

If set, the results will only include archive items which belong to the project identified by this ID.

Optional common list options, the context_id is ignored

Optional common list options, the context_id is ignored

If set, only topics used in audit log events of deployments are returned.

If set, only topics used in audit log events of the ArangoGraph Insights Platform are returned.

Identifier of the organization to request the audit logs for.

If set, the result includes all audit logs, including those who set to deleted, however are not removed from the system currently. If not set, only audit logs not indicated as deleted are returned.

Optional common list options, the context_id is ignored

Identifier of the organization to set the default for.

Identifier of the new default auditlog. If empty, there will be no default auditlog for the organization.

Identifier of the organization.

The HTTPS post settings to test.

Identifier of the audit log. This field is optional, if specified this auditlog is used to revert the redacted content (if any).

Identifier of the destination. This field is optional, if specified this identifier is used, inside the provided audit log to revert the redacted content (if any).

Set if this destination has errors.

Human readable error message (if any).

Resource identifier, example (notebook id)

Resource Type is the kind of resource

Endpoint of a resource

System identifier of the backup. This is a read-only value.

URL of this resource This is a read-only value.

Name of the backup

Description of the backup

Identifier of the deployment that owns this backup. After creation, this value cannot be changed.

Identifier of the backup policy that triggered this backup After creation, this value cannot be changed. If this field is empty, this is a manual backup

The creation timestamp of the backup (database object) This is a read-only value.

The deletion timestamp of the backup This is a read-only value.

Set when this backup is deleted. This is a read-only value.

The timestamp that this backup will be automatically removed You cannot provide a value in the past, If the field is not set, the backup will not be automatically removed.

Information about the deployment during backup

Upload the backup, created by the backup policy, to an external source. Setting or unsetting this fields after the backup has been created will upload/delete the backup from the external source. Setting this field when status.available = false will result in an error

The timestamp of when the upload boolean has been updated. This is a read-only value.

Information about a backup download. If this field is set the backup will be downloaded the deployment. This is a read-only field. To set this field please use the DownloadBackup method.

Identifier of the user who created this backup. This field is set only for manual backups. This is a read-only value.

Status of the actual backup

Identifier of the region in which backup is stored If not set, backup is stored in the same region as of deployment This is a read-only field

Identifier of the backup from which this backup is cloned. If not set, backup is not multi-region backup. This is a read-only field

ArangoDB version of the deployment during backup.

Servers spec of the deployment during backup.

Model of the deployment during backup.

The revision of this DownloadSpec

The timestamp of when the last revision has been updated.

The revision of the used DownloadStatus

Set when the backup has been fully downloaded

The timestamp of when the backup has been fully downloaded.

The creation timestamp of the backup

ArangoDB version of the backup

The state of the backup Will be one of the following: "Pending|Unavailable|Scheduled|Download|DownloadError|Downloading|Create|Upload|Uploading|UploadError|Ready|Deleted|Failed"

Set when the backup is failed

State message

Progress of the backup (upload or download)

Size of the backup (in bytes)

If set the backup is available on the cluster and can be restored

Number of dbservers of the deployment during backup

Indicates that the backup is available in the external source only. You should download the backup before you can restore it.

The status of backup upload (if applicable).

The status of backup download (if applicable). This field will be set to empty if a new revision of the spec is available

Set when the backup has been fully uploaded

The timestamp of when the backup has been fully uploaded

Size of the backup in the external source (in bytes)

Budget for backups

System identifier of the backup policy. This is a read-only value.

URL of this resource This is a read-only value.

Name of the backup policy

Description of the backup policy

Identifier of the deployment that owns this backup policy. After creation, this value cannot be changed.

The creation timestamp of the backup policy This is a read-only value.

The deletion timestamp of the backup policy This is a read-only value.

Set when this backup policy is deleted. This is a read-only value.

Pause this backup policy. If a backup policy is paused, the backup policy will not result in new backups. The backup policy isn't deleted, unsetting this field will resume the creation of backups again.

The schedule for this backup policy

Upload the backup, created by the backup policy, to an external source.

Backups created by this policy will be automatically deleted after the specified retention period A value of 0 means that backup will never be deleted.

The owners of the organization can be notified by email This field support the following values: "Never|FailureOnly|Always"

If set, this backup policy cannot be deleted. To delete, first update the with locked set to false.

Status of the backup policy

List of region identifiers where the backup should be uploaded in addition to the region where the deployment is running. If not set, it should be uploaded to the same region as where the deployment is running. This field can be filled-out only for policies where 'upload' is set.

If set, a backup will be created on Mondays.

If set, a backup will be created on Tuesdays.

If set, a backup will be created on Wednesdays.

If set, a backup will be created on Thursdays.

If set, a backup will be created on Fridays.

If set, a backup will be created on Saturdays.

If set, a backup will be created on Sundays.

The (target) time of the schedule

Schedule should run with an interval of the specified hours (1-23)

Minutes offset is a minute offset to full hour (0-59) when the backup process should start

Run the backup on the specified day of the month (1-31) Note: Specifying a number larger than some months have days will result in no backup for those months (e.g. 29 for February (unless leap year)).

The (target) time of the schedule

Schedule type should be one of the following string: "Hourly|Daily|Monthly" The schedule_hourly, schedule_daily or schedule_montly field should be set Setting multiple fields, or inconsistent with this field result in an error during create/update

Schedule applies to the selected day of the week This is applicable for Hourly type only, ignored for Daily and Monthly

Schedule applies to the selected day of the week This is applicable for Daily type only, ignored for Hourly and Monthly

Schedule applies to the selected day of the month This is applicable for Monthly type only, ignored for Hourly and Daily

The timestamp when the next backup - initiated by this backup policy - will be created

Message in case of failure, otherwise an empty string

Budget for backup policies

Identifier of the backup that is to be copied The source backup should have the 'upload' boolean set.

Identifier of the region where the backup should be copied

Identifier of the deployment to request the backup policies for.

If set, the result includes all backup policies, including those who set to deleted, however are not removed from the system currently. If not set, only backup policies not indicated as deleted are returned.

Optional common list options, the context_id is ignored

Identifier of the deployment to request the backups for.

Request backups that are created at or after this timestamp. This is an optional field.

Request backups that are created before this timestamp. This is an optional field.

If set, only backups that can be recovered from are included in the result. A backup can be recovered from when: - It is available and restorable on the servers of the deployment or - It is uploaded and the upload has finised.

Optional common list options, the context_id is ignored

If set, the results will be sorted by created timestamp.

Sort descending (default is ascending).

Hours part of the time of day (0-23)

Minutes part of the time of day (0-59)

The time-zone this time of day applies to (empty means UTC) Names MUST be exactly as defined in RFC-822.

Address lines

ZIP code (if any)

City

State For US, this must be an ISO 3166-2 2-letter state code See https://en.wikipedia.org/wiki/List_of_U.S._state_abbreviations

Country code

contains information about credits in different currencies

amount of credit

identifier of the currency for this credit

Address of the organization

EU VAT number of the organization (if any)

Email address(es) to send emails related to billing (mostly invoices) to.

US sales tax number of the organization (if any)

Legal name of the organization

The result of PreparePaymentMethod.

First name of owner of payment method

Last name of owner of payment method

Identifier of the organization This is a required field.

System identifier of the invoice.

URL of this resource

Identifier of the organization that is responsible for the payment of this invoice.

Name of the organization that is responsible for the payment of this invoice.

Identifier of the legal entity that is the sender of this invoice.

Name of the legal entity that is the sender of this invoice.

Invoice number (used by accounting)

The creation date of the invoice

If set, this invoice must be manually verified before payment can be initiated.

The last update date of the invoice. This applies to 'specification' only and doesn't apply to status or payments changes.

The list of email addresses that this invoice (and payments related to this invoice) will be send to.

If set, this invoice is generated for an organization that is configured to use purchase orders.

The version of the invoice-builder who created the invoice.

All items of the invoice

Currency for all amounts

Sum all amount for all items (excluding VAT and sales tax)

VAT amount for all items (applicable for Entity GmbH)

If set, the VAT reverse charge rule is applied for this invoice.

The VAT percentage used

Sales tax amount for all items (applicable for Entity Inc.)

The sales tax percentage used

Sum of total_amount_excl_taxes + total_vat + total_sales_tax. This is the amount that the customer will be charged for.

All payment attempts for this invoice, ordered by created_at.

Identifiers of the UsageItems that this item covers.

Amount of money (ex VAT) for this item

Human readable description of this item

If set, this invoice item is already prepaid

If set, this invoice item is already prepaid in credits.

The timestamp of the start of the payment attempt.

Identifier of the payment provider that is used for this payment.

Identifier of this payment (created by payment provider)

Identifier of the payment method that is used for this payment.

If set, this payment is still being processed.

If set, this payment has been payed for succesfully.

If set, this payment has been rejected.

The timestamp of succesfull completion of the payment.

The timestamp of rejected completion of the payment.

Human readable reason for the rejection.

If the currency of the payment method differs from the currency of the invoice, the amount is converted from the currency of the invoice to the currency of the payment method. If such a converted was needed, this field is set to the currency of the payment method.

If the converted_currency_id is non-empty, this field it set to the the amount (in converted currency) that the customer is charged for. This is the total_amount_incl_taxes converted into the payment method currency.

Amount in the invoice currency that was paid with this payment If it's 0, it is assumed that this is a full amount of the invoice

If set, this invoice is still being processed.

If set, a successful payment has been made for this invoice.

If set, all payment attempts for this invoice have been rejected.

If set, this invoice has been verified manually.

If set, this payment needs to be rebuild (by the invoice-builder service). If set, is_completed & is_rejected must be false.

The timestamp of succesfull completion of the payment. This field equals the completed_at field of the last payment if that payment succeeded, nil otherwise.

The timestamp of rejected completion of the payment. This field equals the rejected_at field of the last payment if that payment failed, nil otherwise.

Human readable reason for the completion.

Human readable reason for the rejection.

Identifier of user who completed this invoice.

Identifier of user who rejected this invoice.

Request invoices for the organization with this id. This is a required field.

Request invoices that are created at or after this timestamp. This is an optional field.

Request invoices that are created before this timestamp. This is an optional field.

Standard list options This is an optional field.

Whether or not to include the usage item IDs on every Invoice_Item in the returned Invoices. This is an optional field; usage item IDs are not included by default.

Identifier of the organization for which payment methods are requested.

Optional common list options. (Context ID is ignored)

Identifier of the organization for which payment providers are requested.

Optional common list options. (Context ID is ignored)

If set to true, also return include internal payment providers, for whom users can't create payment methods.

If set, this organization is allowed to list invoices.

If set, this organization is allowed to create/list/update payment methods.

Content of the document

Filename of the document

System identifier of this payment method.

Name of the payment method

Description of the payment method

Identifier of the payment provider used for this payment method This is a read-only field.

Identifier of the organization that owns this payment method This is a read-only field.

Creation timestamp of this payment method This is a read-only field.

Deletion timestamp of this payment method This is a read-only field.

Set if the payment method is deleted. This is a read-only field.

If set, this timestamp specifies when the payment method is no longer valid. If not set, there is no (known) end date for this payment method.

Token for this payment method, provided by the payment provider. This is a read-only field.

Type of payment method

If set, this payment method is the default for its organization. This is a read-only field.

Currency for invoices using this payment method

Last 4 digits of the CC number.

Type of creditcard

System identifier of this payment provider.

Name of the payment provider

Description of the payment provider

Type of payment method supported by this provider

ID of the provider to prepare

ID of the organization that will own the future payment method

Currency for the future payment payment method

ID of the provider of the future payment method

ID of the organization that will own the future payment method

Currency for this payment method

Token (semantics depends on payment provider)

URL of custom script to load to create the payment method

Signature used to verify the consistency of the data in this message.

Identifier of the organization for which billing address is to be set.

Billing configuration to set.

Identifier of the organization for which the default payment method will be set.

Identifier of the new default payment method for the organization.

How many resources of the specific kind are in use

How many resources of the specific kind are still available. Note a value above 0 does not mean that the caller has permission to add those resources.

If set, there is no limit to the number of resources of a specific kind that can be created. If set, available is 0.

System identifier of the object to fetch.

Maximum number of items to return. If not specified, a default number items are returned. Unless specified otherwise, the default number is DefaultPageSize.

Page to start with (defaults to 0).

Identifier of the resource in which the list request is made.

URL of the resource to fetch.

Major version (increasing may break APIs)

Minor version (increased for new features)

Patch version (increased for fixed)

ID of the credit bundle. This is a read-only value.

URL of this credit bundle. This is a read-only value.

The organization this credit bundle belongs to. This is a read-only value.

The number of credits purchased in this bundle. This is a read-only value.

The total price of these credits. This is a read-only value.

Currency used for total_price. This is a read-only value.

The number of credits remaining in this bundle. This is a read-only value.

The date at which this bundle was purchased. This is a read-only value.

The date from which this bundle is valid. This is a read-only value.

The date until which this bundle is valid. This is a read-only value.

Timestamp of when this credit bundle was last used.

Unique identifier of this credit bundle usage.

ID of the usage item this credit bundle usage corresponds to.

ID of the credit bundle from which credit was used.

ID of the organization this credit bundle (and usage) belongs to.

Amount of credits used from the specified credit_bundle_id.

Amount of credits remaining after this usage.

Timestamp at which this credit usage was created.

List of credit usage projections.

Usage value projected for the month in the provided timestamp.

Timestamp (month) for which the given usage value is projected.

ID of the organization in debt.

Amount of debt currently accrued by the specified organization. Zero means no debt.

Timestamp at which this organization first ran out of credits (and went into debt). Not set if there is no debt.

System identifier of the report.

URL of this resource

ID of the organization to which this report belongs.

Amount of credits consumed between the interval in this report (between starts_at and ends_at).

Credit balance at the start of the month.

Credit balance at the end of the month.

Date at which this report was created. This report will contain the monthly usage of the month specified in this timestamp.

List of items in this credit usage report.

Status of the report.

Identifiers of the Credit usages that this item covers.

Amount of credits for this item.

Human readable description of this item

If set, the items in this report are complete for the month specified in `created_at`. No more items will be added to this report once this field is set.

List of credit usage reports.

Identifier of the organization for which a credit usage projection is requested.

Maximum number of projections to return. This is an optional field. If unspecified, defaults to 3.

The organization this credit bundle belongs to. This is a required field.

If set, list the usage for the specified credit bundle only. By default, returns the usage for all credit bundles in this organization. This is an optional field.

The date from which credit usage should be listed. If unspecified, defaults to the date 7 days before `ends_at`. This is an optional field.

The date until which credit usage should be listed. If unspecified, defaults to the current date (at the time of calling the API). This is an optional field.

If set, list the usage for the specified usage item only. This is an optional field.

Common list options context_id is ignored.

ID of the organization for which credit bundles are listed. This is a required field.

If set, exclude expired bundles.

Identifier of the organization for which credit reports are listed.

Request reports that are created at or after this timestamp. This is an optional field.

Request reports that are created before this timestamp. This is an optional field.

Common list options context_id is ignored.

The contents of the PDF. This is a read-only field.

Name of the PDF file. This is a ready-only field.

System identifier of the CA certificate. This is a read-only value.

URL of this resource This is a read-only value.

Name of the CA certificate

Description of the CA certificate

Identifier of the project that owns this CA certificate. This value cannot be changed after creation.

Time from creation of the CA certificate to expiration. This value cannot be changed after creation.

The creation timestamp of the CA certificate This is a read-only value.

The deletion timestamp of the CA certificate This is a read-only value.

The expiration timestamp of the CA certificate This is a read-only value.

A PEM encoded representation of the public key of the CA certificate. This is a read-only value.

Set when this CA certificate is deleted. This is a read-only value.

Set when this CA certificate has expired. This is a read-only value.

Set when this CA certificate will expire in the next month. This is a read-only value.

Set when this certificate is the default in its project. This is a read-only value.

When enabled, deployments using this certificate use a well known TLS certificate on the 8529 port. The self-signed certificates is always hosted on port 18529.

If set, this certificate cannot be deleted. To delete, first update the with locked set to false.

Set when this CA certificate will expire in the next 48 hours. This is a read-only value.

If set, contains the ID of a CA certificate from which this certificate was cloned. This is a read-only value.

Per platform instructions for install/uninstall of the CA certificate

Human readable description of platform. E.g. "MacOS"

Steps needed to install

Steps needed to uninstall

Common list options. Context_id is ignored.

Required ID of project to list certificates for.

If set, include only certificates that were cloned from the certificate with this ID.

System identifier of the currency. E.g. "eur" or "usd"

Human readable name of the currency E.g. "US Dollar"

Human readable sign for the currency. E.g. "$"

ISO 4217 currency code. E.g. "USD"

Optional identifier for the organization to request the default currency for.

System identifier of the size (e.g. standard)

Human readable name of the size (e.g. Standard)

Number of coordinators of the deployment This field is ignored unless model is "flexible".

Amount of memory (in GB) to allocate for each coordinator. This field is ignored unless model is "flexible".

Number of dbservers of the deployment This field is ignored unless model is "flexible".

Amount of memory (in GB) to allocate for each dbserver. This field is ignored unless model is "flexible".

Amount of disk space (in GB) to allocate for each dbserver. This field is ignored unless model is "flexible".

Type of model being used

Size of nodes being used

Number of nodes being used

Amount of disk space per node (in GB)

ID of region in which the deployment will be created.

Per driver instructions for connecting to a deployment

Human readable name of the driver. E.g. "ArangoDB Go driver"

Lines of code

Human readable remarks

URL for getting more information on the driver.

The id of the deployment

Name of the created database

Username of the created user

Password of the created user

Hostname of the database

Port of the database

The total number of bytes of the data volume.

The number of bytes used on the data volume.

The number of bytes available on the data volume.

The total number of inodes of the data volume.

The number of inodes used on the data volume.

The number of inodes available on the data volume.

When this info has been measused

System identifier of the deployment. This is a read-only value.

URL of this resource This is a read-only value.

Name of the deployment

Description of the deployment

Identifier of the project that owns this deployment. After creation, this value cannot be changed.

Identifier of the region in which the deployment is created. After creation, this value cannot be changed.

The creation timestamp of the deployment This is a read-only value.

The deletion timestamp of the deployment This is a read-only value.

Set when this deployment is deleted. This is a read-only value.

Optional identifier of the support plan selected for this deployment. After creation, this value cannot be changed. If no support plan identifier is set, the default support plan is used.

Identifier of the user who created this deployment. This is a read-only value.

This field must be set to the identifier of the current Terms&Conditions when creating a deployment. If the tier of the organization does not require a non-empty Terms&Condition identifier, this field may be left empty. This is a read-only value after creation.

If set, this deployment cannot be deleted. To delete, first update the with locked set to false.

Indicates that this deployment is paused. Use the data.ResumeDeployment method to resume (aka unpause) the deployment. This is a read-only value.

The last paused timestamp of the deployment. This is the timestamp that is_paused is transitioned from unset to set. This is a read-only value.

The last resumed timestamp of the deployment. This is the timestamp that is_paused is transitioned from set to unset. This is a read-only value.

Identifier of the prepaid deployment that this deployment is attached to (if any). This is a read-only value.

If set, authentication for Foxx requests is disabled. Be default this field is not set for new deployments.

When the prepaid deployments starts (relevant when prepaid_deployment_id is set only) This is a read-only value

When the prepaid deployments ends (relevant when prepaid_deployment_id is set only) This is a read-only value

Whenever deployment can be updated to new values from prepaid deployment This is a read-only value

Set if the deployment use a private endpoint. This is a read-only value after creation. If set during creation a private endpoint service will be created.

ArangoDB version to use for this deployment. See Version.version. If you change this value to a higher version, the deployment will be upgraded. If you change this value to a lower patch value, the deployment will be downgraded. Any attempt to change to a lower minor or major version is considered an invalid request. Any attempt to change to a version that is not in the list of available versions is considered an invalid request.

If set, this deployment will be upgraded to the ArangoDB release with the version as listed in this field.

If set, it is recommended to upgrade to the ArangoDB release with the version as listed in this field.

If set, the version used by this deployment is no longer actively supported. This is a readonly field.

Optional identifier of IP allowlist to use for this deployment.

If provided, dataclusterd will use this custom image tag instead of the configured one for a given version. Further, ImagePullPolicy will be set to Always. This field can only be set by selected organizations.

Optional identifier of IAM provider to use for this deployment.

Optional identifier of disk performance to use for this deployment.

If set, the disk performance cannot be updated, due to other reasons than the disk rate limit. This is a read-only value

Disk rate limit is the (fixed) period required to wait before a next disk action can be executed. A value of 0 means that there is no rate limit. If now - (last_disk_performance_updated_at or last_disk_size_updated_at) > disk_rate_limit_period it is not allowed to update dbserver_disk_size or disk_performance_id.

Timestamp when the last time the disk performance has been updated. This is a read-only value

Timestamp when the last time the disk size has been updated. This is a read-only value

Disk rate limit active is the active period required to wait before a next disk action can be executed. The difference between disk_rate_limit_period and this field is that disk_rate_limit_period is a constant value (independent) if the rate limit is active, this field will count down, if the field is 0 you can modify. If this field is set it is not allowed to update dbserver_disk_size or disk_performance_id. This is a read-only value

Detailed size of the deployment This is a read-only field.

Information about a backup restore. If this field is set the deployment will be restored to that backup. This is a read-only field. To set this field please use the backup service RestoreBackup method.

Recommendations made for deployments using the "oneshard" or "sharded" model.

Set if this deployment is a clone and should be handled differently. After bootstrapping a clone needs a restore operation. This is a read-only property

The ID of the backup to restore this clone deployment from. This is a read-only property

Deployment's notification settings

Deployment's disk autoscaling settings [Deprecated] This setting isn't supported anymore. To increase disk space you need to switch to a larger node-size [e.g. A8 (with 80Gib)--> A16 (with 160 Gib)]

Determines if root's password scheduled rotation is enabled for the deployment. This is a readonly field.

Time when the last time root password rotated for the deployment. For the existing deployments, this field is not set until they enable scheduled root password rotation. For the new deployments, this field will have the same value with deployment's `created_at`. This is a readonly field.

Optional identifier of the deployment profile for this deployment. After creation, this value cannot be changed.

Determines if deployment is using platform authentication

The (optional) intended use-case for this deployment

If set to true, drop support for deprecated VST protocol and improve resilience. Defaults to false.

Defines notifications attached to the Deployment

The revision of this BackupRestoreSpec

The timestamp of when the last revision has been updated.

Identifier of the user that restored this backup. This is a read-only value.

Identifier of a backup to restore to.

The revision of the used BackupRestoreSpec

The timestamp of when the backup restore status was updated.

Set if the deployment is preparing or restoring a backup

Status of the restore backup operation. Enum of the following values: "<empty>|Preparing|Restoring|Restored|Failed"

Failure reason of the backup restore (if applicable)

Identifier of the CACertificate used to sign TLS certificates for the deployment. If you change this value after the creation of the deployment a complete rotation of the deployment is required, which will result in some downtime.

Zero or more DNS names to include in the TLS certificate of the deployment.

Maximum allowed disk size that a node can reach (in GB). [Deprecated] This setting isn't supported anymore.

The expiration timestamp of the deployment If not set, the deployment will not expire.

Human readable reason for why the deployment expires (or does not expire).

The timestamp of when the last "this deployment will expire at" email was send. If not set, no such email has been send.

List of email addresses to which the last warning email has been send. Not set when no such email has been send.

Type of model being used

Size of nodes being used This field is ignored set in case the flexible model is used.

Number of nodes being used This field is ignored set in case the flexible model is used.

Amount of disk space per node (in GB) This field is ignored set in case the flexible model is used.

Email addresses that notifications related to this deployment should be sent to.

ID of the server

Type of server (agent|coordinator|dbserver)

Human readable description of the status of the deployment.

The creation timestamp of the server

Set once the server is ready

Set once the server has been known to be a member of the cluster

Set if the server is in a failed state Every server is always in 1 (and only 1) of these states: failed/creating/ok/bad/upgrading.

Set if the server is still being created Every server is always in 1 (and only 1) of these states: failed/creating/ok/bad/upgrading.

Set if the server is in the ok state. Every server is always in 1 (and only 1) of these states: failed/creating/ok/bad/upgrading.

Set if the server is in the bad state. Every server is always in 1 (and only 1) of these states: failed/creating/ok/bad/upgrading.

Set if the server is still being upgraded Every server is always in 1 (and only 1) of these states: failed/creating/ok/bad/upgrading.

Latest known ArangoDB version used by this server. Initially this field is empty.

The last started timestamp of the server

If set, a rotation of this server has been requested.

If set, this server reports that it can be deleted.

If set, this server is leader in its type (currently applies only to agents).

Information about the data volume used to store the data

Recent number of restarts

Last known memory usage in bytes

Last known CPU usage in vCPU units

Last known memory limit in bytes

Last known CPU limit in vCPU units

Number of coordinators of the deployment This field is automatically set unless the flexible model is used.

Amount of memory (in GB) to allocate for coordinators. This field is automatically set unless the flexible model is used.

Custom command line arguments passed to all coordinators. This field is ignored set unless the flexible model is used.

Number of dbservers of the deployment This field is automatically set unless the flexible model is used.

Amount of memory (in GB) to allocate for dbservers. This field is automatically set unless the flexible model is used.

Amount of disk space (in GB) to allocate for dbservers. This field is automatically set unless the flexible model is used.

Custom command line arguments passed to all dbservers. This field is ignored set unless the flexible model is used.

The minimum number of dbservers based on the highest replication factor defined by all databases and all collections.

The minimum amount of disk space (in GB) to allocate for dbservers based on the highest usage of all running DB servers. The nearest size (larger then indicated here) need to be depected if the provider doesn't support all values (See GetServersSpecLimits)

Endpoint URL used to reach the deployment This value will be empty during the creation of the deployment. This field always contains the URL of the low port (8529) of the deployment. If a certificate with well known certificate is used, this port is using the well known certificate. Otherwise this port is using the self-signed certificate.

Human readable description of the status of the deployment.

Set once the deployment has been created.

Set if the deployment is ready to be used. If the deployment has downtime (e.g. because of changing a CA certificate) this will go to false until the downtime is over.

Set if the deployment is being upgraded.

Versions of running servers

Status of individual servers of the deployment

Set if the ready boolean is transitioned to true for the very first time.

Set if bootstrapped_at has a value, otherwise false.

Endpoint URL used to reach the deployment on the port that uses the self-signed certificate. This endpoint is recommended for machine-to-database connections.

Endpoint URL used to reach the deployment on default port (443) This value will be empty during the creation of the deployment. If a certificate with well known certificate is used, this port is using the well known certificate. Otherwise this port is using the self-signed certificate. This endpoint is recommended for human-to-database connections.

If set, this deployment has a private endpoint, however can contain the public endpoint as well. When switching from a public endpoint to a private endpoint the public endpoint will be available for an hour to support seemlessly migration to the private endpoint.

If set, this deployment has a private endpoint only. When switching from a public endpoint to a private endpoint the public endpoint will be available for an hour to support seemlessly migration to the private endpoint.

Endpoint URL used to reach the deployment which is configured as a private endpoint. This field always contains the URL of the low port (8529) of the deployment. If a certificate with well known certificate is used, this port is using the well known certificate, note that the alternate DNS names are not part of this certificate. Otherwise this port is using the self-signed certificate. This endpoint is recommended for human-to-database connections. If no private endpoint is configured this field will be empty.

Endpoint URL used to reach the deployment on the port that uses the self-signed certificate. This certificate will contain the specified alternate DNS names as well, so a secure TLS connection can be establised. This endpoint is recommended for machine-to-database connections. If no private endpoint is configured this field will be empty.

Private Endpoint URL used to reach the deployment on default port (443) This value will be empty during the creation of the deployment & private endpoint. this port is using the well known certificate.

The status of backup restore (if applicable). This field will be set to empty if a new revision of the spec is available

The total size of all backups in the external source (in bytes)

Set if there is any backup currently uploading data to the external source

Set if the deployment is up-to-date and has no pending updates.

Set if the deployment is in read-only mode.

Name of the user for which credentials were asked. Default to username of root user.

Password of the user for which credentials were asked.

Identifier of deployment to request credentials for.

Reason for requesting the credentials

Is the use of an IAM provider available?

Is the use of the pause feature available?

Is the use of the ML features available?

Is the use of monitoring feature available?

Identifier of project that will own a deployment.

Identifier of a region in which a deployment will be created.

Model of the intended deployment.

Node size use for the intended deployments

Actual deployments

Budget for deployments

System identifier of the model (e.g. oneshard)

Human readable name of the model (e.g. One shard)

Limit the time-to-live of deployments created with this model. Time-to-live (till expiration) is expressed in seconds. A value of '0' means no expiration.

If set, ML is available as a trial only.

If set, private endpoints are allowed for this deployment model.

If set, metrics endpoint integration is allowed for this deployment model.

If set, backups for this deployment model are allowed to be uploaded to the cloud.