Enterprise Analytics Links REST API (2.2)

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.
• gcs: A link to the Google Cloud Storage service.
• http: A link to an HTTP service.

For Couchbase links only. The remote hostname.

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.

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.

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.

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.

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.

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.

For Couchbase links only. The content of the target cluster root certificate(s), as an alternative to certificate. May contain multiple certificates, separated by new lines, to support certificate rotation.

You should URL-encode this parameter to escape any special characters.

For Couchbase links only. A JSON object describing how to obtain the passphrase used to decrypt an encrypted client key.

For Couchbase links only. A JSON object configuring TLS verification (verifyPeer, verifyHostname) for links with full encryption.

For Couchbase links only. If set to true, the link is prevented from following redirects to the target cluster's active nodes.

For S3 links only. The Amazon S3 region.

For S3 links only. The Amazon S3 access key ID. Required when using access key authentication. Must be provided together with secretAccessKey.

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.

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.

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.

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.

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.

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.

For S3 links only. The Amazon S3 service endpoint.

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.

For S3 links only. If set to true, SSL verification is disabled.

For S3 links only. Controls when the client sends additional integrity checksums on requests, primarily for S3-compatible storage. when_required only sends a checksum when the service requires one; when_supported sends one whenever the service supports it.

For S3 links only. The S3 input-stream implementation to use when reading objects.

For S3 links only. The change-detection mode used when reading objects (none disables change detection).

The endpoint URI.

Required for Azure Blob links; optional for S3 links (e.g. when using S3-compatible storage).

For Azure Blob links only. The account name. Used for shared key authentication.

You should URL-encode this parameter to escape any special characters.

For Azure Blob links only. The account key. Used for shared key authentication.

You should URL-encode this parameter to escape any special characters.

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.

For Google Cloud Storage links only. The JSON credentials of the link.

This parameter is not allowed if applicationDefaultCredentials is provided.

For Google Cloud Storage links only. If true, the link uses Google Application Default Credentials for authentication. Cannot be combined with jsonCredentials.

The bearer token for bearer token authentication. Cannot be combined with username, password, or OAuth2 parameters.

You should URL-encode this parameter to escape any special characters.

The OAuth2 token URI. Required for OAuth2 authentication. Must be provided together with oauthClientId and oauthClientSecret. Cannot be combined with bearerToken, username, or password.

The OAuth2 client ID. Required for OAuth2 authentication. Must be provided together with oauthTokenUri and oauthClientSecret.

The OAuth2 client secret. Required for OAuth2 authentication. Must be provided together with oauthTokenUri and oauthClientId.

You should URL-encode this parameter to escape any special characters.

The type of the link. If this parameter is specified, the value must match the type that was set when the link was created.

For Couchbase links only. The remote hostname.

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.

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.

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.

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.

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.

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.

For Couchbase links only. The content of the target cluster root certificate(s), as an alternative to certificate. May contain multiple certificates, separated by new lines, to support certificate rotation.

You should URL-encode this parameter to escape any special characters.

For Couchbase links only. A JSON object describing how to obtain the passphrase used to decrypt an encrypted client key.

For Couchbase links only. A JSON object configuring TLS verification (verifyPeer, verifyHostname) for links with full encryption.

For Couchbase links only. If set to true, the link is prevented from following redirects to the target cluster's active nodes.

For S3 links only. The Amazon S3 region.

For S3 links only. The Amazon S3 access key ID. Required when using access key authentication. Must be provided together with secretAccessKey.

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.

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.

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.

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.

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.

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.

For S3 links only. The Amazon S3 service endpoint.

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.

For S3 links only. If set to true, SSL verification is disabled.

For S3 links only. Controls when the client sends additional integrity checksums on requests, primarily for S3-compatible storage. when_required only sends a checksum when the service requires one; when_supported sends one whenever the service supports it.

For S3 links only. The S3 input-stream implementation to use when reading objects.

For S3 links only. The change-detection mode used when reading objects (none disables change detection).

The endpoint URI.

Required for Azure Blob links; optional for S3 links (e.g. when using S3-compatible storage).

For Azure Blob links only. The account name. Used for shared key authentication.

You should URL-encode this parameter to escape any special characters.

For Azure Blob links only. The account key. Used for shared key authentication.

You should URL-encode this parameter to escape any special characters.

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.

For Google Cloud Storage links only. The JSON credentials of the link.

This parameter is not allowed if applicationDefaultCredentials is provided.

For Google Cloud Storage links only. If true, the link uses Google Application Default Credentials for authentication. Cannot be combined with jsonCredentials.

The bearer token for bearer token authentication. Cannot be combined with username, password, or OAuth2 parameters.

You should URL-encode this parameter to escape any special characters.

The OAuth2 token URI. Required for OAuth2 authentication. Must be provided together with oauthClientId and oauthClientSecret. Cannot be combined with bearerToken, username, or password.

The OAuth2 client ID. Required for OAuth2 authentication. Must be provided together with oauthTokenUri and oauthClientSecret.

The OAuth2 client secret. Required for OAuth2 authentication. Must be provided together with oauthTokenUri and oauthClientId.

You should URL-encode this parameter to escape any special characters.