API Guide

Using the REST API
Representational state transfer (REST) is a software architectural style that defines constraints that are used to provide interoperability
between systems on the Internet. RESTful Web services allow the requesting systems to access and manipulate textual representations
of web resources by using a uniform and predefined set of stateless operations. These stateless operations include GET, POST, PUT ,
DELETE, and SET.
SmartFabric Director (SFD) browser-based GUI uses REST APIs to interface with SFD. Any client that wants to interface with SFD must
use these REST APIs, typically over HTTPS.
HTTP methods
GET Retrieves the URIs of the member resources of the collection resource in the response body.
POST Creates a member resource in the collection resource using the instructions in the requested body. The URI of the
created member resource is automatically assigned, and the returned in the response location header field.
PUT Replaces all the representations of the member resources of the collection resource with the representation in the
request body. This method also creates the collection resource if it does not exist.
DELETE Delete all the representations of the member resources of the collection resource.
The GET method is safe, meaning that applying it to a resource does not cause a resource state change. The GET method is read-only.
The GET, PUT, and DELETE methods are idempotent, meaning that applying these methods multiple times to a resource results in the
same state change of the resource as applying them once, though the response may differ.
Security and authentication
Key
sfd_api_key
Type
apiKey
Description Token that is retrieved from login request should be sent in authorization header with value SFD {token}.
2
8 Using the REST API