Introduction › Basic REST Operations

Basic REST Operations

Endpoints are types of items, such as groups, monitoring profiles, tenants, and device certifications. Use specific endpoints with the following request methods or basic operations to return a list of results, or create, update, or delete an item.

Note: Individual metric family items and SNMP vendor certification items are specified using name instead of ID.

Important! Set the Context-type files to application/xml when you perform operations using Data Aggregator REST web services.

Basic operations include:

GET http://.../endpoint

Returns a list of all items of the specified type. The getlist.xsd schema defines the format for the return data.

GET http://.../endpoint/[id | name]

Returns the details for a single item with the specified ID or certification name. The XSD schema defines the format for the return data.

POST http://.../endpoint

Creates an object of the specified type with specified facets. The XSD schema defines the format for the return data.

Note: When creating (using POST), it is possible to create objects with the same name but different IDs. This convention is allowed because it is often valid when the objects are scoped to different tenants. When creating or updating objects, name the objects according to what the user interface can represent.

PUT http://.../endpoint/[id | name]

Updates the attributes of the specified item. The update.xsd schema defines the format and expected fields.

Note: When updating (using PUT), it is possible to create objects with the same name but different IDs. This convention is allowed because it is often valid when the objects are scoped to different tenants. When creating or updating objects, name the objects according to what the user interface can represent.

DELETE http://.../endpoint/[id | name]

Deletes the item that is specified using the ID or certification name.