Get an IP pool

GET 
/v1/ip-pool/get

Retrieve details of a specific IP pool

Request

Query Parameters

provider stringrequired

Possible values: [sparkpost]

Provider Name

pool_id stringrequired

Pool ID

Responses

200

OK

application/json

Schema

Schema

data

object

created_at string

deleted_at string

details

object

property name* any

pool_id string

provider string
message string
success boolean

Example (from schema)

{
  "data": {
    "created_at": "string",
    "deleted_at": "string",
    "details": {},
    "pool_id": "string",
    "provider": "string"
  },
  "message": "IP pool retrieved successfully",
  "success": true
}

400

Bad Request

application/json

Schema

Schema

details string
error string
success boolean

Example (from schema)

{
  "details": "string",
  "error": "string",
  "success": false
}

404

Not Found

application/json

Schema

Schema

details string
error string
success boolean

Example (from schema)

{
  "details": "string",
  "error": "string",
  "success": false
}

500

Internal Server Error

application/json

Schema

Schema

details string
error string
success boolean

Example (from schema)

{
  "details": "string",
  "error": "string",
  "success": false
}

Loading...