/
Hierarchy level

Hierarchy level

Hierarchy level defines the structure and organization of resource names in the API. Each level is separated by a slash (/) in the parameter name. Using hierarchy levels helps you logically group and manage related resources or parameters.

Example - Three hierarchy levels

In this parameter name:

credentials/payment-gateway/api-key

There are three hierarchy levels:

  • credentials

  • payment-gateway

  • api-key

Hierarchy level limit

For Global parameters, the API enforces a limit on the number of hierarchy levels you can use in a resource name.

If you try to create or update a parameter with more than ten levels, the API returns a 400 Bad Request error.

Example - Hierarchy level limit

In the Create parameters, the name field has the following description:

…The name hierarchy cannot exceed 10 levels.

This means that a parameter name can have a maximum of ten segments, with each segment separated by a slash (/). Each segment is considered one level in the hierarchy.