Download OpenAPI specification:
This API enables you to manage the links to remote Couchbase clusters and external data sources.
Creates a link
| name required | string The name of the link. |
| type required | string (Create Request Type) Enum: "couchbase" "s3" The type of the link.
#* |
| 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. For details, see encryption. |
| 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. #For Azure Blob links, this is the client certificate for the registered application. #Used for Azure Active Directory client certificate authentication. 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. |
| accessKeyId required | string For S3 links only. The Amazon S3 access key ID. |
| secretAccessKey required | string For S3 links only. The Amazon S3 secret access key. 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. Passing this parameter indicates that the |
| region required | string For S3 links only. The Amazon S3 region. |
| serviceEndpoint | string For S3 links only. The Amazon S3 service endpoint. |
{- "error": "string"
}Returns information about a link.
| name required | string The name of the link. |
| type | string (Edit Request Type) Enum: "couchbase" "s3" The type of the link. If this parameter is specified, the value must match the type that was set when the link was created. |
[- {
- "name": "myLink",
- "type": "couchbase"
}
]Edits an existing link. The link name and type cannot be modified.
| name required | string The name of the link. |
| type | string (Edit Request Type) Enum: "couchbase" "s3" 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. For details, see encryption. |
| 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. #For Azure Blob links, this is the client certificate for the registered application. #Used for Azure Active Directory client certificate authentication. 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. |
| accessKeyId required | string For S3 links only. The Amazon S3 access key ID. |
| secretAccessKey required | string For S3 links only. The Amazon S3 secret access key. 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. Passing this parameter indicates that the |
| region required | string For S3 links only. The Amazon S3 region. |
| serviceEndpoint | string For S3 links only. The Amazon S3 service endpoint. |
{- "error": "string"
}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.
| name required | string The name of the link. |
{- "error": "string"
}