Enterprise Analytics Links REST API (2.1)

Download OpenAPI specification:

This API enables you to manage the links to remote Couchbase clusters and external data sources.

Single Links

Operations for single links.

Create Link

Creates a link

Authorizations:

AnalyticsManageCreateLink

path Parameters

name

required

string

The name of the link.

Request Body schema: application/x-www-form-urlencoded

type required	string (Create Request Type) Enum: "couchbase" "s3" "azureblob" The type of the link. `couchbase`: A link to a remote Couchbase cluster. `s3`: A link to the Amazon S3 service. `azureblob`: A link to the Azure Blob Storage service.
hostname required	string For Couchbase links only. The remote hostname.
username	string For Couchbase links only. The remote username. Required for links with no encryption or half encryption. Required for links with full encryption if using a password. You should URL-encode this parameter to escape any special characters.
password	string For Couchbase links only. The remote password. Required for links with no encryption or half encryption. Required for links with full encryption if using a username. You should URL-encode this parameter to escape any special characters.
encryption required	string Enum: "none" "half" "full" For Couchbase links only. The type of encryption used by the link. `none`: Neither passwords nor data are encrypted. `half`: Passwords are encrypted using SCRAM-SHA, but data is not. `full`: All data and passwords are encrypted and TLS is used.
certificate	string For Couchbase links only. The content of the target cluster root certificate. Required for links with full encryption. You should URL-encode this parameter to escape any special characters. If required, this parameter may contain multiple certificates, separated by new lines.
clientCertificate	string For Couchbase links, this is the content of the client certificate. Required for links with full encryption if using a client key. You should URL-encode this parameter to escape any special characters.
clientKey	string For Couchbase links only. The content of the client key. Required for links with full encryption if using a client certificate. You should URL-encode this parameter to escape any special characters.
region required	string For S3 links only. The Amazon S3 region.
accessKeyId	string For S3 links only. The Amazon S3 access key ID. Required when using access key authentication. Must be provided together with `secretAccessKey`.
secretAccessKey	string For S3 links only. The Amazon S3 secret access key. Required when using access key authentication. Must be provided together with `accessKeyId`. You should URL-encode this parameter to escape any special characters.
sessionToken	string For S3 links only. The Amazon S3 session token. Use this parameter if you want the link to have temporary access. Requires `accessKeyId` and `secretAccessKey` to also be provided. Passing this parameter indicates that the credentials are temporary. The Amazon S3 service validates the session token with each request to check whether the provided credentials have expired or are still valid.
instanceProfile	string Value: "true" For S3 links only. If set to `true`, the link uses the EC2 instance profile for authentication. Cannot be combined with `accessKeyId`, `secretAccessKey`, or `sessionToken`.
roleArn	string For S3 links only. The Amazon Resource Name (ARN) of the role to assume for cross-account authentication. Requires either `instanceProfile` or `accessKeyId` and `secretAccessKey` (non-temporary) to provide the credentials used to assume the role.
externalId	string For S3 links only. An external ID for cross-account role assumption. Used together with `roleArn`. If `roleArn` is provided and `externalId` is not, one is automatically generated and returned in the response.
crossRegion	string Enum: "true" "false" For S3 links only. If set to `true`, allows the link to access S3 buckets in regions other than the one specified by `region`. Warning: Accessing buckets in a different region incurs cross-region data transfer charges.
serviceEndpoint	string For S3 links only. The Amazon S3 service endpoint.
pathStyleAddressing	string Enum: "true" "false" For S3 links only. If set to `true`, uses path-style addressing for S3 requests instead of virtual-hosted-style. Defaults to `true` if `serviceEndpoint` is set.
disableSslVerify	boolean For S3 links only. If set to `true`, SSL verification is disabled.
endpoint required	string The endpoint URI. Required for Azure Blob links; optional for S3 links (e.g. when using S3-compatible storage).
accountName	string For Azure Blob links only. The account name. Used for shared key authentication. You should URL-encode this parameter to escape any special characters.
accountKey	string For Azure Blob links only. The account key. Used for shared key authentication. You should URL-encode this parameter to escape any special characters.
sharedAccessSignature	string For Azure Blob links only. A token that can be used for authentication. Used for shared access signature authentication. You should URL-encode this parameter to escape any special characters.

Responses

Response samples

400
500

Content type

application/json

{"error": "string"
}

Query Link

Returns information about a link.

Authorizations:

AnalyticsManageDescribeLink

path Parameters

name

required

string

The name of the link.

query Parameters

type	string (Edit Request Type) Enum: "couchbase" "s3" "azureblob" The type of the link. If this parameter is specified, the value must match the type that was set when the link was created.

Responses

Response samples

200
400
500

Content type

application/json

[{"name": "myLink",
"type": "couchbase"
}
]

Edit Link

Edits an existing link. The link name and type cannot be modified.

Authorizations:

AnalyticsManageAlterLink

path Parameters

name

required

string

The name of the link.

Request Body schema: application/x-www-form-urlencoded

type	string (Edit Request Type) Enum: "couchbase" "s3" "azureblob" The type of the link. If this parameter is specified, the value must match the type that was set when the link was created.
hostname required	string For Couchbase links only. The remote hostname.
username	string For Couchbase links only. The remote username. Required for links with no encryption or half encryption. Required for links with full encryption if using a password. You should URL-encode this parameter to escape any special characters.
password	string For Couchbase links only. The remote password. Required for links with no encryption or half encryption. Required for links with full encryption if using a username. You should URL-encode this parameter to escape any special characters.
encryption required	string Enum: "none" "half" "full" For Couchbase links only. The type of encryption used by the link. `none`: Neither passwords nor data are encrypted. `half`: Passwords are encrypted using SCRAM-SHA, but data is not. `full`: All data and passwords are encrypted and TLS is used.
certificate	string For Couchbase links only. The content of the target cluster root certificate. Required for links with full encryption. You should URL-encode this parameter to escape any special characters. If required, this parameter may contain multiple certificates, separated by new lines.
clientCertificate	string For Couchbase links, this is the content of the client certificate. Required for links with full encryption if using a client key. You should URL-encode this parameter to escape any special characters.
clientKey	string For Couchbase links only. The content of the client key. Required for links with full encryption if using a client certificate. You should URL-encode this parameter to escape any special characters.
region required	string For S3 links only. The Amazon S3 region.
accessKeyId	string For S3 links only. The Amazon S3 access key ID. Required when using access key authentication. Must be provided together with `secretAccessKey`.
secretAccessKey	string For S3 links only. The Amazon S3 secret access key. Required when using access key authentication. Must be provided together with `accessKeyId`. You should URL-encode this parameter to escape any special characters.
sessionToken	string For S3 links only. The Amazon S3 session token. Use this parameter if you want the link to have temporary access. Requires `accessKeyId` and `secretAccessKey` to also be provided. Passing this parameter indicates that the credentials are temporary. The Amazon S3 service validates the session token with each request to check whether the provided credentials have expired or are still valid.
instanceProfile	string Value: "true" For S3 links only. If set to `true`, the link uses the EC2 instance profile for authentication. Cannot be combined with `accessKeyId`, `secretAccessKey`, or `sessionToken`.
roleArn	string For S3 links only. The Amazon Resource Name (ARN) of the role to assume for cross-account authentication. Requires either `instanceProfile` or `accessKeyId` and `secretAccessKey` (non-temporary) to provide the credentials used to assume the role.
externalId	string For S3 links only. An external ID for cross-account role assumption. Used together with `roleArn`. If `roleArn` is provided and `externalId` is not, one is automatically generated and returned in the response.
crossRegion	string Enum: "true" "false" For S3 links only. If set to `true`, allows the link to access S3 buckets in regions other than the one specified by `region`. Warning: Accessing buckets in a different region incurs cross-region data transfer charges.
serviceEndpoint	string For S3 links only. The Amazon S3 service endpoint.
pathStyleAddressing	string Enum: "true" "false" For S3 links only. If set to `true`, uses path-style addressing for S3 requests instead of virtual-hosted-style. Defaults to `true` if `serviceEndpoint` is set.
disableSslVerify	boolean For S3 links only. If set to `true`, SSL verification is disabled.
endpoint required	string The endpoint URI. Required for Azure Blob links; optional for S3 links (e.g. when using S3-compatible storage).
accountName	string For Azure Blob links only. The account name. Used for shared key authentication. You should URL-encode this parameter to escape any special characters.
accountKey	string For Azure Blob links only. The account key. Used for shared key authentication. You should URL-encode this parameter to escape any special characters.
sharedAccessSignature	string For Azure Blob links only. A token that can be used for authentication. Used for shared access signature authentication. You should URL-encode this parameter to escape any special characters.

Responses

Response samples

400
500

Content type

application/json

{"error": "string"
}

Delete Link

Deletes a link. The link cannot be deleted if any other entities are using it, such as a collection. The entities using the link need to be disconnected from the link, otherwise, the delete operation fails.

Authorizations:

AnalyticsManageDropLink

path Parameters

name

required

string

The name of the link.

Responses

Response samples

400
500

Content type

application/json

{"error": "string"
}

Multiple Links

Operations for multiple links.

Query All Links

Returns information about all links

Authorizations:

AnalyticsManageDescribeLink

Responses

Response samples

200
400
500

Content type

application/json

[{"name": "myLink",
"type": "couchbase"
}
]