Get prefix

GET

/api/prefixes/{id}

const url = 'http://localhost:3000/api/prefixes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {cookie: 'session=<session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/prefixes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie session=<session>

Authorizations

cookieAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

Success

application/json

object

data

object

required

string format: uuid

prefix

required

string

vrfId

string format: uuid

nullable

siteId

string format: uuid

nullable

vlanId

string format: uuid

nullable

status

required

string

Allowed values: active container reserved deprecated

isPool

required

boolean

description

string

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "data": {
    "prefix": "10.0.0.0/24",
    "status": "active"
  }
}

401

Not authenticated

application/json

object

error

required

string

Example

{
  "error": "Not found"
}

404

Prefix not found

application/json

object

error

required

string

Example

{
  "error": "Not found"
}