Add API resources

API resources are unique services in an API endpoint. You add resources by entering their basic information, such as name and path, and specifying methods you want to associate them with.

How to

  1. On the Register new API page, in the API resources panel, click the plus () icon.
    A new resource with configuration parameters appears.
  2. In the Resource name field, enter a name for the resource.
  3. In the Resource path field, enter the resource path relative to the hostnames where the resource resides in the following format: /path

    The resource path is case-sensitive. This means that, for example, /path and /Path denote two different resources.

    When entering a resource path, you can use curly brackets ({}) to define path parameters (for example,/path/{pathparam1}). If desired, you can also define multiple path parameters (for example, /path/{pathparam1},{pathparame2},{pathparam3}). All path parameters that you define this way automatically appear in the methods that you select for a resource.

    The resource path appears after the base path in the resource URL.
  4. Optional: In the Resource notes field, enter additional information related to the resource.
  5. In the Methods section, select the methods that you want to enable for the resource.
    When you associate a method with a resource, you define how API consumers can use the resource. For example, by selecting the PUT method, you allow API consumers to modify the resource.
  6. Optional: If you have access to KSD features, add parameters to the methods. Follow Add parameters to methods.
  7. Click Save.

What you should see

A sample API resource configuration may look like this:
API resource example