Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
             id: 2
           name: Virtual
         org_id: 1
    description: 
           type: load balancing
        purpose: virtualisation
         status: active
  configuration: active/active
    environment: production
        scaling: fixed
 retrieved_name: 
retrieved_ident: 
      edited_by: Administrator
    edited_date: 2020-02-03 13:15:18

Example Device entry

Code Block
         id: 2
  system_id: 353
clusters_id: 2
       role: node
    current: y
  edited_by: Administrator
edited_date: 2020-02-03 13:15:28


API / Web Access

You can access the /locations collection using the normal Open-AudIT JSON based API. Just like any other collection. Please see the API documentation for further details.

API Routes


Request MethodIDActionResulting FunctionURL ExampleNotes
GETncollectionclusters::read/clustersReturns a list of clusters.
GETyreadclusters::read/clusters/{id}Returns a clusters details.
PATCHyupdateclusters::update/clusters/{id}Update an attribute of a clusters entry.
POSTncreateclusters::create/clustersInsert a new clusters entry.
DELETEydeleteclusters::delete/clusters/{id}Delete a clusters entry.


Web Application Routes

Request MethodIDActionResulting FunctionURL ExampleNotes
GETncreatecreate_form/clusters/createDisplays a standard web form for submission to POST /clusters.
GETyupdateupdate_form/clusters/{id}/updateShow the networks details with the option to update attributes using PATCH to /clusters/{id}