Skip to content

ACLs

All operations require authentication.

5 operationsv2/publicCloud/project
Agent setup

List topic ACLsBeta

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/kafka/{serviceId}/acl

Returns the topic ACL entries of the service, each granting a user a permission on a topic name pattern.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Acl[]successful operation
checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the resource was created

id
read-only
stringuuid

Unique identifier of the ACL entry

permission
read-only
AclPermissionEnum

Permission level granted by this ACL entry

ValuesADMINREADREAD_WRITEWRITE
topic
read-only
string

Topic name pattern this ACL entry applies to. Supports wildcards (*).

updatedAt
read-only
stringdate-time

Date of the last update to the resource

username
read-only
string

Username this ACL entry applies to

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafka/{serviceId}/acl \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "permission": "ADMIN", "topic": "string", "updatedAt": "2024-01-01T12:00:00Z", "username": "string" }]

Get a topic ACLBeta

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/kafka/{serviceId}/acl/{aclId}

Returns the user, the topic name pattern and the permission of the ACL entry.

Path parameters

aclId
required
stringuuid

Acl ID

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Response

200Aclsuccessful operation
checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the resource was created

id
read-only
stringuuid

Unique identifier of the ACL entry

permission
read-only
AclPermissionEnum

Permission level granted by this ACL entry

ValuesADMINREADREAD_WRITEWRITE
topic
read-only
string

Topic name pattern this ACL entry applies to. Supports wildcards (*).

updatedAt
read-only
stringdate-time

Date of the last update to the resource

username
read-only
string

Username this ACL entry applies to

Example uses aclId = 00000000-0000-0000-0000-000000000000, projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafka/{serviceId}/acl/{aclId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "permission": "ADMIN", "topic": "string", "updatedAt": "2024-01-01T12:00:00Z", "username": "string"}

Create a topic ACLBeta

POST
/v2/publicCloud/project/{projectId}/managedAnalytics/kafka/{serviceId}/acl

Grants a user a permission on the topics matching a name pattern. Use * to match all topics.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Request body (required)

permission
required
AclPermissionEnum

Permission level to grant

ValuesADMINREADREAD_WRITEWRITE
topic
required
string

Topic name pattern this ACL applies to. Use * to match all topics.

username
required
string

Username to grant access to

Response

200Aclsuccessful operation
checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the resource was created

id
read-only
stringuuid

Unique identifier of the ACL entry

permission
read-only
AclPermissionEnum

Permission level granted by this ACL entry

ValuesADMINREADREAD_WRITEWRITE
topic
read-only
string

Topic name pattern this ACL entry applies to. Supports wildcards (*).

updatedAt
read-only
stringdate-time

Date of the last update to the resource

username
read-only
string

Username this ACL entry applies to

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafka/{serviceId}/acl \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "permission": "ADMIN", "topic": "string", "updatedAt": "2024-01-01T12:00:00Z", "username": "string"}

Delete a topic ACLBeta

DELETE
/v2/publicCloud/project/{projectId}/managedAnalytics/kafka/{serviceId}/acl/{aclId}

Deletes the ACL entry and revokes the permission it granted.

Path parameters

aclId
required
stringuuid

Acl ID

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Response

200Aclsuccessful operation
checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the resource was created

id
read-only
stringuuid

Unique identifier of the ACL entry

permission
read-only
AclPermissionEnum

Permission level granted by this ACL entry

ValuesADMINREADREAD_WRITEWRITE
topic
read-only
string

Topic name pattern this ACL entry applies to. Supports wildcards (*).

updatedAt
read-only
stringdate-time

Date of the last update to the resource

username
read-only
string

Username this ACL entry applies to

Example uses aclId = 00000000-0000-0000-0000-000000000000, projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafka/{serviceId}/acl/{aclId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "permission": "ADMIN", "topic": "string", "updatedAt": "2024-01-01T12:00:00Z", "username": "string"}

List ACL permissionsBeta

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/kafka/{serviceId}/permissions

Returns the permission names available for topic ACLs and for Schema Registry ACLs.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Response

200Permissionssuccessful operation
schemaRegistry
read-only
string[]

Available Schema Registry permission names

topic
read-only
string[]

Available topic permission names

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafka/{serviceId}/permissions \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "schemaRegistry": [ "string" ], "topic": [ "string" ]}