COcouchbase
AI Data Plane Providers

Get provider

Changed on

Fetches the details of a specific provider.

In order to access this endpoint, the provided API key must have at least one of the following roles:

  • Organization Owner

To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/aiServices/providers/{providerId}

Request

Path parameters

organizationIdstring uuid required
Example:ffffffff-aaaa-1414-eeee-000000000000

The GUID4 ID of the organization.

providerIdstring required
Example:provider1-ffffffff-aaaa-1414-eeee-000000000000

The unique identifier of the provider.

Response

Successfully fetched the details of the provider.

namestring

The name of the provider.

typestring

The type of the provider.

Example response

{
  "name": "my-aws-s3-provider",
  "type": "awsS3",
  "audit": {
    "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "createdAt": "2021-09-01T12:34:56Z",
    "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "modifiedAt": "2021-09-01T12:34:56Z",
    "version": 1
  }
}

Changes