GET https://api.copyleaks.com/v3/repositories/repository/{repositoryId}/info

Get repository information such as credit consumption, metadata values and current status. A “Super Admin” or “Admin” role is required.

Authentication Required

You need to login with a user and api key in order to access this method. Add this HTTP header to your request:

Authorization: Bearer < Your-Login-Token >

Need Help?

Not sure how to generate your login token? Read here.

Request

Path Parameters

repositoryId string required

The repository ID to get the info for. The repository ID can be fetched from the Copyleaks Admin Dashboard.

Headers

Authorization: Bearer YOUR_LOGIN_TOKEN

Responses

200

200 OK

The command was executed.

Example Response

A typical response from this endpoint:

{
  "id": "private-data-hub-id",
  "name": "Private Data Hub Name",
  "description": "Your Description",
  "permission": 4,
  "status": 0,
  "maxCredits": 1000,
  "currentCredits": 1000,
  "maskingPolicy": 0,
  "creationTime": "2024-09-09T10:43:52"
}

400

400 Bad Request

Bad Request.

Example Response

A typical response from this endpoint:

{
  "repositoryId": [
    "The field repositoryId must match the regular expression '^[_A-Za-z0-9]*$'."
  ]
}

401

401 Unauthorized

Unauthorized - Authorization has been denied for this request.

Example Response

A typical response from this endpoint:

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.2",
  "title": "Unauthorized",
  "status": 401,
  "traceId": "00-ef0db7690ced98431ac97782051edc77-2c4194d74ae6c08b-00"
}

403

403 Forbidden

Forbidden. Your organization role does not permit you to perform this request. This operation requires "Super Admin" or "Admin" role.

Examples

HTTP

GET https://api.copyleaks.com/v3/repositories/repository/my-repo-123/info
Authorization: Bearer YOUR_LOGIN_TOKEN

cURL

curl --request GET \
  --url https://api.copyleaks.com/v3/repositories/repository/my-repo-123/info \
  --header 'Authorization: Bearer YOUR_LOGIN_TOKEN'