Resources

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

Examples of resources:

  • The resource utilization information 

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

  • A list of configured VLANs: 

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

  • The administrative state of port 1/1/3: 

    https://192.0.2.5/rest/v1/system/ports/1%2F1%2F3?attributes=admin

  • 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