API
Get Started
Requests

Requests

Any HTTP tools can communicate with our API simply by requesting the right URI. You must make the request using the HTTPS protocol in order to encrypt the traffic transferring over that connection. The interface responds to different methods depending on the action required.

  • Name
    get
    Type
    Description

    You should use the GET method to recall information about your Stacklets, account or infrastructure, using this method, all the information will be rendered as a JSON object.

    However, other attributes returned by the JSON object will be used to form additional requests and will be returned as read-only, which will not affect the objects you are inquiring.

  • Name
    delete
    Type
    Description

    The DELETE method is performed to destroy and remove a resource from the user account and subsequently the Stacklet. This command will delete the resource if it's to be found, if not, the method will return a message stating that the resource is not found.

    Note: Don't performed a resource availability check before using the DELETE method, as this check is performed during the method execution.

  • Name
    put
    Type
    Description

    The PUT method is used to update the attributes of a resource in the user Stacklet. While execution, the PUT method will update the resource regardless of its values or attribution.

    Note: If the resource is available on the Stacklet, this command will update it, if not, it will create a new resource with the attributes included in the method.

  • Name
    post
    Type
    Description

    The POST method is used to create object or objects in the user account and/or Stacklet. When creating new object/s send the POST method along with the attributes necessary to create the object to the target location/s.

  • Name
    head
    Type
    Description

    The HEAD method is used with the GET request to retrieve all the information about the header metadata.

    Header metadata usually represent the user API access information.