Resources

In a REST API, the primary representation of data is called aresource. A resource is a representation of an entity in the system as a URI. The entities can include hardware objects, statistical information, configuration information, and status information. The URI might or might not include a query component. Resources are nouns—anything that can be named can be a resource.

Examples of resources:

  • The resource utilization information:

    • https://192.0.0.5/rest/v1/system/subsystems?attributes=resource_utilization

  • The list of configured VLANs:

    • https://192.0.2.5/rest/v1/system/vlans

  • The list of all users:

    • https://192.0.2.5/rest/v1/system/users

  • The user with the ID:myadmin:

    • https://192.0.2.5/rest/v1/system/users/myadmin

  • The secondary firmware image:

    • https://192.0.2.5/rest/v1/firmware?image=secondary