Folders

Get a folder type

GET/folder-types/{id}
documents:readget_folder_typeRead-only

Returns one folder type. An unknown id returns 404. Use GET /folder-types to list the types, and match a folder's type_id against id. It changes nothing.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Query parameters

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

Responses

200

The folder type.

FolderType
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "value": "string",
    "label": "string"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/folder-types/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"