IP Addresses

#IP addresses an account can use

GET/api/v1/ips/choices

Who

root, reseller (ACL: create-acct or edit-account)

API tokens

admin token area: server

Operation

ipChoices · ky call ipChoices

Responses

• 200 OK
  Body

  Field	Type
  items	array of StoreIPChoice

• 401 Unauthorized: no session, or an invalid or expired token
• 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
• 500 Internal Server Error: internal

#List the server's IP addresses

GET/api/v1/server/ips

Who

root

API tokens

admin token area: server

Operation

adminIPs · ky call adminIPs

Responses

• 200 OK
  Body

  Field	Type
  items	array of StoreIPAddress
  shared_id	string
  system	map of any
  system_error	string

• 401 Unauthorized: no session, or an invalid or expired token
• 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
• 500 Internal Server Error: internal

#Add IP addresses

POST/api/v1/server/ips

Who

root

API tokens

admin token area: server

Operation

adminAddIPs · ky call adminAddIPs

Request body

Responses

• 201 Created
  Body

  Field	Type
  added	array of StoreIPAddress
  skipped	array of string

• 400 Bad Request: validation
• 401 Unauthorized: no session, or an invalid or expired token
• 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)

#Remove an IP address

DELETE/api/v1/server/ips/{iid}

Who

root

API tokens

admin token area: server

Operation

adminDeleteIP · ky call adminDeleteIP

Parameters

Responses

• 204 Done, no content
• 401 Unauthorized: no session, or an invalid or expired token
• 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
• 404 Not Found: not-found
• 409 Conflict: in-use
• 500 Internal Server Error: internal

#Bind an IP address to the network interface

POST/api/v1/server/ips/{iid}/bind

Who

root

API tokens

admin token area: server

Operation

adminBindIP · ky call adminBindIP

Parameters

Request body

Responses

• 200 OK
  Body

  map of any

• 400 Bad Request: rejected, validation
• 401 Unauthorized: no session, or an invalid or expired token
• 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
• 404 Not Found: not-found
• 409 Conflict: in-use, main-ip
• 500 Internal Server Error: internal

#Make an IP address shared or dedicated

PUT/api/v1/server/ips/{iid}/kind

Who

root

API tokens

admin token area: server

Operation

adminIPKind · ky call adminIPKind

Parameters

Request body

Responses

• 200 OK
  Body

  Field	Type
  account_id	string
  accounts always	integer
  address always	string
  created_at always	integer
  family always	integer
  id always	string
  interface	string
  kind always	string
  nat_public	string
  prefix_len always	integer
  username	string

• 400 Bad Request: validation
• 401 Unauthorized: no session, or an invalid or expired token
• 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
• 404 Not Found: not-found
• 409 Conflict: in-use
• 500 Internal Server Error: internal

#Choose the shared IP address

PUT/api/v1/server/ips/shared

Who

root

API tokens

admin token area: server

Operation

adminSharedIP · ky call adminSharedIP

Request body

Responses

• 200 OK
  Body

  Field	Type
  address	string
  shared_id	string

• 400 Bad Request: validation
• 401 Unauthorized: no session, or an invalid or expired token
• 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
• 500 Internal Server Error: internal