Skip to main content

Trident REST API

Contributors netapp-rlithman juliantap netapp-aruldeepa
PDFs

While tridentctl commands and options are the easiest way to interact with the Trident REST API, you can use the REST endpoint directly if you prefer.

When to use the REST API

REST API is useful for advanced installations that use Trident as a standalone binary in non-Kubernetes deployments.

For better security, the Trident REST API is restricted to localhost by default when running inside a pod. To change this behavior, you need to set Trident's -address argument in its pod configuration.

Using REST API

For examples of how these APIs are called, pass the debug (-d) flag. For more information, refer to Manage Trident using tridentctl.

The API works as follows:

GET

GET <trident-address>/trident/v1/<object-type>

Lists all objects of that type.

GET <trident-address>/trident/v1/<object-type>/<object-name>

Gets the details of the named object.

POST

POST <trident-address>/trident/v1/<object-type>

Creates an object of the specified type.

  • Requires a JSON configuration for the object to be created. For the specification of each object type, refer to Manage Trident using tridentctl.

  • If the object already exists, behavior varies: backends update the existing object, while all other object types will fail the operation.

DELETE

DELETE <trident-address>/trident/v1/<object-type>/<object-name>

Deletes the named resource.

Note Volumes associated with backends or storage classes will continue to exist; these must be deleted separately. For more information, refer to Manage Trident using tridentctl.