Server IP Justification Update

From INAP Dropzone API
(Difference between revisions)
Jump to: navigation, search
(Created page with "Justification")
 
(Returned Data)
 
(8 intermediate revisions by one user not shown)
Line 1: Line 1:
 
Justification
 
Justification
 +
 +
==Path==
 +
*/server/ip/justification/{$serverid}
 +
 +
==Method==
 +
*[[glossary#get|POST]]
 +
 +
==Availability==
 +
*[[servers#Dedicated Server|Dedicated Server]]
 +
*[[servers#Dynamic Server|Dynamic Server]]
 +
*[[servers#Private Cloud|Private Cloud]]
 +
*[[servers#Public Cloud|Public Cloud]]
 +
 +
==Required Data Parameters==
 +
*{$serverid}: The server ID that is returned when using the [[Server List|list]] command.
 +
 +
*[[glossary#get|POST]] parameters:
 +
 +
*{$request_id}: Obtain the request id by using the GET method.
 +
*{$object_id}: This is the unique id of the server.
 +
*{$request_notes}: Use this field to update the Notes on the Justification.
 +
*{$request_items}: Request Items are an array of IP addresses assigned to the server under the justification request. Use this to provide notes for each ip_address, to provide proof of justifiable utilization.
 +
 +
application/json
 +
<pre>
 +
[
 +
    {
 +
        "request_id": ,
 +
        "object_id": ,
 +
        "request_notes": ,
 +
        "request_items": [ {"ip_address": , "notes":  },  ]   
 +
    } ,
 +
 +
]
 +
</pre>
 +
 +
==Optional Data Parameters==
 +
*None
 +
 +
==Returned Data==
 +
application/json
 +
<pre>
 +
[
 +
    {
 +
      "request_id": This is the unique ID of the request,
 +
      "client_id": "",
 +
      "object_id": "",
 +
      "justification_id": "",
 +
      "request_notes": "",
 +
      "ip_amount": "",
 +
      "ticket_id": "",
 +
      "created_on": "",
 +
      "request_status": "",
 +
      "processed_ts": "",
 +
      "cidr": "",
 +
      "last_modified_ts": "",
 +
      "justification_name": "",
 +
      "justification_desc": "",
 +
      "ip_range": "",
 +
      "request_items": [ { "ip_address":, "notes":  } , ]
 +
    } ,
 +
 +
]
 +
</pre>

Latest revision as of 16:49, 5 May 2017

Justification

Contents

Path

  • /server/ip/justification/{$serverid}

Method

Availability

Required Data Parameters

  • {$serverid}: The server ID that is returned when using the list command.
  • {$request_id}: Obtain the request id by using the GET method.
  • {$object_id}: This is the unique id of the server.
  • {$request_notes}: Use this field to update the Notes on the Justification.
  • {$request_items}: Request Items are an array of IP addresses assigned to the server under the justification request. Use this to provide notes for each ip_address, to provide proof of justifiable utilization.

application/json

[
    {
        "request_id": ,
        "object_id": ,
        "request_notes": ,
        "request_items": [ {"ip_address": , "notes":  },  ]     
    } ,

]

Optional Data Parameters

  • None

Returned Data

application/json

[
    {
      "request_id": This is the unique ID of the request,
      "client_id": "",
      "object_id": "",
      "justification_id": "",
      "request_notes": "",
      "ip_amount": "",
      "ticket_id": "",
      "created_on": "",
      "request_status": "",
      "processed_ts": "",
      "cidr": "",
      "last_modified_ts": "",
      "justification_name": "",
      "justification_desc": "",
      "ip_range": "",
      "request_items": [ { "ip_address":, "notes":  } , ]
    } ,

]
Personal tools