Depot networkmap

View as Markdown Open in ChatGPT Open in Claude

Registers the MSP face’s routes: the practice profile and library, and each client’s override and icons.

This page is generated from the Depot route table. Every operation carries the permission it needs and the anchor an agent can link to.

GET `/api/v1/clients/{clientId}/network-map/icons`

GETdiscovery:readmsp facemspIdempotent

Source: [object Object]

List client icons

Parameters

Name	In	Type	Required	Description
`clientId`	path	string	Yes

Responses

Status	Body	Description
`200`	`application/json`, object	Success.
`400`	`application/problem+json`, ProblemDetails	One or more validation errors occurred.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold discovery:read.
`404`	`application/problem+json`, ProblemDetails	No such client.
`500`	`application/problem+json`, ProblemDetails	The request failed.

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/clients/<clientId>/network-map/icons' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/clients/<clientId>/network-map/icons' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

import (
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST `/api/v1/clients/{clientId}/network-map/icons`

POSTnetwork_map:managemsp facemsp

Source: [object Object]

Create client icon

Parameters

Name	In	Type	Required	Description
`clientId`	path	string	Yes

Request body

Required, sent as multipart/form-data.

The body is object.

Responses

Status	Body	Description
`201`	`application/json`, DiagramIconView	Created.
`400`	`application/problem+json`, ProblemDetails	One or more validation errors occurred.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold network_map:manage.
`404`	`application/problem+json`, ProblemDetails	No such client.
`500`	`application/problem+json`, ProblemDetails	Could not save the icon.
`503`	`application/problem+json`, ProblemDetails	Network map settings are not available on this Depot.

201 response body

Field	Type	Description
`clientId`	`string or null`
`contentType`required	`string`
`createdAt`required	`string (date-time)`
`id`required	`string`
`matchKind`	`string or null`
`matchModel`	`string or null`
`matchVendor`	`string or null`
`name`required	`string`
`url`required	`string`

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
curl -X POST 'https://depot.example.com/api/v1/clients/<clientId>/network-map/icons' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: multipart/form-data' \
  -b 'outpost_console=<console-session>' \
  --data '{}'

# Sign in first. outpost_console is a session cookie, so send it with every request.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Content-Type' = 'multipart/form-data'
    'Cookie' = 'outpost_console=<console-session>'
}

$body = @'
{}
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/clients/<clientId>/network-map/icons' `
    -Headers $headers `
    -ContentType 'multipart/form-data' `
    -Body $body

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.

import requests

url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "multipart/form-data",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {}

response = requests.post(url, headers=headers, cookies=cookies, json=payload, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
package main

import (
  "bytes"
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  body := []byte(`{}`)

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons", bytes.NewReader(body))
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.Header.Set("Content-Type", "multipart/form-data")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "multipart/form-data",
  },
  credentials: "include",
  body: JSON.stringify({}),
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

const string body = """
{}
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");
request.Content = new StringContent(body, Encoding.UTF8, "multipart/form-data");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH `/api/v1/clients/{clientId}/network-map/icons/{iconId}`

PATCHnetwork_map:managemsp facemsp

Source: [object Object]

Patch client icon

Parameters

Name	In	Type	Required	Description
`clientId`	path	string	Yes
`iconId`	path	string	Yes

Request body

Required, sent as application/json.

Field	Type	Description
`matchKind`	`string or null`
`matchModel`	`string or null`
`matchVendor`	`string or null`
`name`	`string or null`

Responses

Status	Body	Description
`200`	`application/json`, DiagramIconView	Success.
`400`	`application/problem+json`, ProblemDetails	One or more validation errors occurred.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold network_map:manage.
`404`	`application/problem+json`, ProblemDetails	No such client.
`500`	`application/problem+json`, ProblemDetails	Could not save the icon.
`503`	`application/problem+json`, ProblemDetails	Network map settings are not available on this Depot.

200 response body

Field	Type	Description
`clientId`	`string or null`
`contentType`required	`string`
`createdAt`required	`string (date-time)`
`id`required	`string`
`matchKind`	`string or null`
`matchModel`	`string or null`
`matchVendor`	`string or null`
`name`required	`string`
`url`required	`string`

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
curl -X PATCH 'https://depot.example.com/api/v1/clients/<clientId>/network-map/icons/<iconId>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "matchKind": "string",
  "matchModel": "string",
  "matchVendor": "string",
  "name": "string"
}'

# Sign in first. outpost_console is a session cookie, so send it with every request.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Content-Type' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$body = @'
{
  "matchKind": "string",
  "matchModel": "string",
  "matchVendor": "string",
  "name": "string"
}
'@

$response = Invoke-RestMethod `
    -Method Patch `
    -Uri 'https://depot.example.com/api/v1/clients/<clientId>/network-map/icons/<iconId>' `
    -Headers $headers `
    -ContentType 'application/json' `
    -Body $body

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.

import requests

url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons/<iconId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "matchKind": "string",
    "matchModel": "string",
    "matchVendor": "string",
    "name": "string",
}

response = requests.patch(url, headers=headers, cookies=cookies, json=payload, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
package main

import (
  "bytes"
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  body := []byte(`{
  "matchKind": "string",
  "matchModel": "string",
  "matchVendor": "string",
  "name": "string"
}`)

  req, err := http.NewRequest(http.MethodPatch, "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons/<iconId>", bytes.NewReader(body))
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.Header.Set("Content-Type", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons/<iconId>";

const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify({
    "matchKind": "string",
    "matchModel": "string",
    "matchVendor": "string",
    "name": "string"
  }),
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

const string body = """
{
  "matchKind": "string",
  "matchModel": "string",
  "matchVendor": "string",
  "name": "string"
}
""";

var request = new HttpRequestMessage(HttpMethod.Patch, "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons/<iconId>");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");
request.Content = new StringContent(body, Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE `/api/v1/clients/{clientId}/network-map/icons/{iconId}`

DELETEnetwork_map:managemsp facemspIdempotent

Source: [object Object]

Delete client icon

Parameters

Name	In	Type	Required	Description
`clientId`	path	string	Yes
`iconId`	path	string	Yes

Responses

Status	Body	Description
`204`	None	Success, with no body.
`400`	`application/problem+json`, ProblemDetails	One or more validation errors occurred.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold network_map:manage.
`404`	`application/problem+json`, ProblemDetails	No such client.
`500`	`application/problem+json`, ProblemDetails	Could not delete the icon.
`503`	`application/problem+json`, ProblemDetails	Network map settings are not available on this Depot.

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X DELETE 'https://depot.example.com/api/v1/clients/<clientId>/network-map/icons/<iconId>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Delete `
    -Uri 'https://depot.example.com/api/v1/clients/<clientId>/network-map/icons/<iconId>' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons/<iconId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.delete(url, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

import (
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  req, err := http.NewRequest(http.MethodDelete, "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons/<iconId>", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons/<iconId>";

const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Delete, "https://depot.example.com/api/v1/clients/<clientId>/network-map/icons/<iconId>");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET `/api/v1/clients/{clientId}/network-map/style`

GETdiscovery:readmsp facemspIdempotent

Source: [object Object]

Get client style

Parameters

Name	In	Type	Required	Description
`clientId`	path	string	Yes

Responses

Status	Body	Description
`200`	`application/json`, ClientStyleView	Success.
`400`	`application/problem+json`, ProblemDetails	One or more validation errors occurred.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold discovery:read.
`404`	`application/problem+json`, ProblemDetails	No such client.
`500`	`application/problem+json`, ProblemDetails	The request failed.

200 response body

Field	Type	Description
`effective`required	`StyleProfile`	StyleProfile is a practice's drawing style, or a client's override of it (14.1).
`effective.labels`	`LabelTemplate`	LabelTemplate shapes port and cable labels (18.3).
`effective.labels.cable`	`string`
`effective.labels.port`	`string`
`effective.links`	`object`
`effective.nodes`required	`LegacyNodes`	legacyNodes reads any value and keeps none of it, so it is always zero.
`effective.sheet`	`SheetStyle`	SheetStyle is the drawing sheet's options (18.3).
`effective.sheet.footer`	`string or null`
`effective.sheet.legend`	`boolean or null`
`effective.sheet.logo`	`boolean or null`
`effective.sheet.orientation`	`string`
`effective.sheet.paper`	`string`
`effective.sheet.revisionTable`	`boolean or null`
`effective.sheet.titleBlock`	`boolean or null`
`effective.speedTiers`	`array of SpeedTier`
`effective.speedTiers[].minMbps`required	`integer`
`effective.speedTiers[].width`required	`number`	double.
`effective.speedWidth`	`boolean or null`
`effective.version`	`integer`
`override`required	`StyleProfile`	StyleProfile is a practice's drawing style, or a client's override of it (14.1).
`override.labels`	`LabelTemplate`	LabelTemplate shapes port and cable labels (18.3).
`override.labels.cable`	`string`
`override.labels.port`	`string`
`override.links`	`object`
`override.nodes`required	`LegacyNodes`	legacyNodes reads any value and keeps none of it, so it is always zero.
`override.sheet`	`SheetStyle`	SheetStyle is the drawing sheet's options (18.3).
`override.sheet.footer`	`string or null`
`override.sheet.legend`	`boolean or null`
`override.sheet.logo`	`boolean or null`
`override.sheet.orientation`	`string`
`override.sheet.paper`	`string`
`override.sheet.revisionTable`	`boolean or null`
`override.sheet.titleBlock`	`boolean or null`
`override.speedTiers`	`array of SpeedTier`
`override.speedTiers[].minMbps`required	`integer`
`override.speedTiers[].width`required	`number`	double.
`override.speedWidth`	`boolean or null`
`override.version`	`integer`
`updatedAt`	`string (date-time) or null`

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/clients/<clientId>/network-map/style' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/clients/<clientId>/network-map/style' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/style"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

import (
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/clients/<clientId>/network-map/style", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/style";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/clients/<clientId>/network-map/style");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

PUT `/api/v1/clients/{clientId}/network-map/style`

PUTnetwork_map:managemsp facemspIdempotent

Source: [object Object]

Put client style

Parameters

Name	In	Type	Required	Description
`clientId`	path	string	Yes

Request body

Required, sent as application/json.

Field	Type	Description
`labels`	`LabelTemplate`	LabelTemplate shapes port and cable labels (18.3).
`labels.cable`	`string`
`labels.port`	`string`
`links`	`object`
`nodes`required	`LegacyNodes`	legacyNodes reads any value and keeps none of it, so it is always zero.
`sheet`	`SheetStyle`	SheetStyle is the drawing sheet's options (18.3).
`sheet.footer`	`string or null`
`sheet.legend`	`boolean or null`
`sheet.logo`	`boolean or null`
`sheet.orientation`	`string`
`sheet.paper`	`string`
`sheet.revisionTable`	`boolean or null`
`sheet.titleBlock`	`boolean or null`
`speedTiers`	`array of SpeedTier`
`speedTiers[].minMbps`required	`integer`
`speedTiers[].width`required	`number`	double.
`speedWidth`	`boolean or null`
`version`	`integer`

Responses

Status	Body	Description
`200`	`application/json`, ClientStyleView	Success.
`400`	`application/problem+json`, ProblemDetails	One or more validation errors occurred.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold network_map:manage.
`404`	`application/problem+json`, ProblemDetails	No such client.
`500`	`application/problem+json`, ProblemDetails	Could not save the network map style.
`503`	`application/problem+json`, ProblemDetails	Network map settings are not available on this Depot.

200 response body

Field	Type	Description
`effective`required	`StyleProfile`	StyleProfile is a practice's drawing style, or a client's override of it (14.1).
`effective.labels`	`LabelTemplate`	LabelTemplate shapes port and cable labels (18.3).
`effective.labels.cable`	`string`
`effective.labels.port`	`string`
`effective.links`	`object`
`effective.nodes`required	`LegacyNodes`	legacyNodes reads any value and keeps none of it, so it is always zero.
`effective.sheet`	`SheetStyle`	SheetStyle is the drawing sheet's options (18.3).
`effective.sheet.footer`	`string or null`
`effective.sheet.legend`	`boolean or null`
`effective.sheet.logo`	`boolean or null`
`effective.sheet.orientation`	`string`
`effective.sheet.paper`	`string`
`effective.sheet.revisionTable`	`boolean or null`
`effective.sheet.titleBlock`	`boolean or null`
`effective.speedTiers`	`array of SpeedTier`
`effective.speedTiers[].minMbps`required	`integer`
`effective.speedTiers[].width`required	`number`	double.
`effective.speedWidth`	`boolean or null`
`effective.version`	`integer`
`override`required	`StyleProfile`	StyleProfile is a practice's drawing style, or a client's override of it (14.1).
`override.labels`	`LabelTemplate`	LabelTemplate shapes port and cable labels (18.3).
`override.labels.cable`	`string`
`override.labels.port`	`string`
`override.links`	`object`
`override.nodes`required	`LegacyNodes`	legacyNodes reads any value and keeps none of it, so it is always zero.
`override.sheet`	`SheetStyle`	SheetStyle is the drawing sheet's options (18.3).
`override.sheet.footer`	`string or null`
`override.sheet.legend`	`boolean or null`
`override.sheet.logo`	`boolean or null`
`override.sheet.orientation`	`string`
`override.sheet.paper`	`string`
`override.sheet.revisionTable`	`boolean or null`
`override.sheet.titleBlock`	`boolean or null`
`override.speedTiers`	`array of SpeedTier`
`override.speedTiers[].minMbps`required	`integer`
`override.speedTiers[].width`required	`number`	double.
`override.speedWidth`	`boolean or null`
`override.version`	`integer`
`updatedAt`	`string (date-time) or null`

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X PUT 'https://depot.example.com/api/v1/clients/<clientId>/network-map/style' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "labels": {
    "cable": "string",
    "port": "string"
  },
  "links": {
    "key": {
      "arrow": false,
      "dash": "string",
      "stroke": "string",
      "width": 0
    }
  },
  "nodes": {},
  "sheet": {
    "footer": "string",
    "legend": false,
    "logo": false,
    "orientation": "string",
    "paper": "string",
    "revisionTable": false,
    "titleBlock": false
  },
  "speedTiers": [
    {
      "minMbps": 0,
      "width": 0
    }
  ],
  "speedWidth": false,
  "version": 0
}'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Content-Type' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$body = @'
{
  "labels": {
    "cable": "string",
    "port": "string"
  },
  "links": {
    "key": {
      "arrow": false,
      "dash": "string",
      "stroke": "string",
      "width": 0
    }
  },
  "nodes": {},
  "sheet": {
    "footer": "string",
    "legend": false,
    "logo": false,
    "orientation": "string",
    "paper": "string",
    "revisionTable": false,
    "titleBlock": false
  },
  "speedTiers": [
    {
      "minMbps": 0,
      "width": 0
    }
  ],
  "speedWidth": false,
  "version": 0
}
'@

$response = Invoke-RestMethod `
    -Method Put `
    -Uri 'https://depot.example.com/api/v1/clients/<clientId>/network-map/style' `
    -Headers $headers `
    -ContentType 'application/json' `
    -Body $body

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/style"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "labels": {
        "cable": "string",
        "port": "string",
    },
    "links": {
        "key": {
            "arrow": False,
            "dash": "string",
            "stroke": "string",
            "width": 0,
        },
    },
    "nodes": {},
    "sheet": {
        "footer": "string",
        "legend": False,
        "logo": False,
        "orientation": "string",
        "paper": "string",
        "revisionTable": False,
        "titleBlock": False,
    },
    "speedTiers": [
        {
            "minMbps": 0,
            "width": 0,
        },
    ],
    "speedWidth": False,
    "version": 0,
}

response = requests.put(url, headers=headers, cookies=cookies, json=payload, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

import (
  "bytes"
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  body := []byte(`{
  "labels": {
    "cable": "string",
    "port": "string"
  },
  "links": {
    "key": {
      "arrow": false,
      "dash": "string",
      "stroke": "string",
      "width": 0
    }
  },
  "nodes": {},
  "sheet": {
    "footer": "string",
    "legend": false,
    "logo": false,
    "orientation": "string",
    "paper": "string",
    "revisionTable": false,
    "titleBlock": false
  },
  "speedTiers": [
    {
      "minMbps": 0,
      "width": 0
    }
  ],
  "speedWidth": false,
  "version": 0
}`)

  req, err := http.NewRequest(http.MethodPut, "https://depot.example.com/api/v1/clients/<clientId>/network-map/style", bytes.NewReader(body))
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.Header.Set("Content-Type", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/style";

const response = await fetch(url, {
  method: "PUT",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify({
    "labels": {
      "cable": "string",
      "port": "string"
    },
    "links": {
      "key": {
        "arrow": false,
        "dash": "string",
        "stroke": "string",
        "width": 0
      }
    },
    "nodes": {},
    "sheet": {
      "footer": "string",
      "legend": false,
      "logo": false,
      "orientation": "string",
      "paper": "string",
      "revisionTable": false,
      "titleBlock": false
    },
    "speedTiers": [
      {
        "minMbps": 0,
        "width": 0
      }
    ],
    "speedWidth": false,
    "version": 0
  }),
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

const string body = """
{
  "labels": {
    "cable": "string",
    "port": "string"
  },
  "links": {
    "key": {
      "arrow": false,
      "dash": "string",
      "stroke": "string",
      "width": 0
    }
  },
  "nodes": {},
  "sheet": {
    "footer": "string",
    "legend": false,
    "logo": false,
    "orientation": "string",
    "paper": "string",
    "revisionTable": false,
    "titleBlock": false
  },
  "speedTiers": [
    {
      "minMbps": 0,
      "width": 0
    }
  ],
  "speedWidth": false,
  "version": 0
}
""";

var request = new HttpRequestMessage(HttpMethod.Put, "https://depot.example.com/api/v1/clients/<clientId>/network-map/style");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");
request.Content = new StringContent(body, Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE `/api/v1/clients/{clientId}/network-map/style`

DELETEnetwork_map:managemsp facemspIdempotent

Source: [object Object]

Delete client style

Parameters

Name	In	Type	Required	Description
`clientId`	path	string	Yes

Responses

Status	Body	Description
`204`	None	Success, with no body.
`400`	`application/problem+json`, ProblemDetails	One or more validation errors occurred.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold network_map:manage.
`404`	`application/problem+json`, ProblemDetails	No such client.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	Network map settings are not available on this Depot.

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X DELETE 'https://depot.example.com/api/v1/clients/<clientId>/network-map/style' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Delete `
    -Uri 'https://depot.example.com/api/v1/clients/<clientId>/network-map/style' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/style"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.delete(url, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

import (
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  req, err := http.NewRequest(http.MethodDelete, "https://depot.example.com/api/v1/clients/<clientId>/network-map/style", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/clients/<clientId>/network-map/style";

const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Delete, "https://depot.example.com/api/v1/clients/<clientId>/network-map/style");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET `/api/v1/network-map/glyphs`

GETdiscovery:readshared facehosteditmspremoteIdempotent

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

glyphs answers the built-in kind glyphs (topology.KindIcons): SVG path data on a 24 x 24 grid per kind.

The same for everyone and every build, so browsers may keep it.

Responses

Status	Body	Description
`200`	`application/json`, object	Success.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold discovery:read.

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/network-map/glyphs' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/network-map/glyphs' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/network-map/glyphs"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

import (
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/network-map/glyphs", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/network-map/glyphs";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/network-map/glyphs");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET `/api/v1/network-map/icons/{iconId}`

GETdiscovery:readshared facehosteditmspremoteIdempotentdownloadNot fully resolved

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

What this page does not know

response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

iconBytes streams one icon.

On the tenant face only the practice’s icons and the request’s own client’s are visible; another client’s is 404.

Parameters

Name	In	Type	Required	Description
`iconId`	path	string	Yes

Responses

Status	Body	Description
`200`	`application/octet-stream`, string (binary)	Success. The body shape was not resolved; see x-outpost-unresolved.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold discovery:read.
`404`	`application/problem+json`, ProblemDetails	No such icon.
`500`	`application/problem+json`, ProblemDetails	Could not read the icon.

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/network-map/icons/<iconId>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/network-map/icons/<iconId>' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/network-map/icons/<iconId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

import (
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/network-map/icons/<iconId>", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/network-map/icons/<iconId>";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/network-map/icons/<iconId>");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET `/api/v1/organization/network-map/icons`

GETdiscovery:readshared facehosteditmspremoteIdempotent

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

List practice icons

Responses

Status	Body	Description
`200`	`application/json`, object	Success.
`400`	`application/problem+json`, ProblemDetails	One or more validation errors occurred.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold discovery:read.
`500`	`application/problem+json`, ProblemDetails	The request failed.

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/organization/network-map/icons' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/organization/network-map/icons' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/organization/network-map/icons"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

import (
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/organization/network-map/icons", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/organization/network-map/icons";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/organization/network-map/icons");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST `/api/v1/organization/network-map/icons`

POSTnetwork_map:manageshared facehosteditmspremote

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

Create practice icon

Request body

Required, sent as multipart/form-data.

The body is object.

Responses

Status	Body	Description
`201`	`application/json`, DiagramIconView	Created.
`400`	`application/problem+json`, ProblemDetails	One or more validation errors occurred.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold network_map:manage.
`404`	`application/problem+json`, ProblemDetails	No such client.
`500`	`application/problem+json`, ProblemDetails	Could not save the icon.
`503`	`application/problem+json`, ProblemDetails	Network map settings are not available on this Depot.

201 response body

Field	Type	Description
`clientId`	`string or null`
`contentType`required	`string`
`createdAt`required	`string (date-time)`
`id`required	`string`
`matchKind`	`string or null`
`matchModel`	`string or null`
`matchVendor`	`string or null`
`name`required	`string`
`url`required	`string`

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
curl -X POST 'https://depot.example.com/api/v1/organization/network-map/icons' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: multipart/form-data' \
  -b 'outpost_console=<console-session>' \
  --data '{}'

# Sign in first. outpost_console is a session cookie, so send it with every request.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Content-Type' = 'multipart/form-data'
    'Cookie' = 'outpost_console=<console-session>'
}

$body = @'
{}
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/organization/network-map/icons' `
    -Headers $headers `
    -ContentType 'multipart/form-data' `
    -Body $body

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.

import requests

url = "https://depot.example.com/api/v1/organization/network-map/icons"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "multipart/form-data",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {}

response = requests.post(url, headers=headers, cookies=cookies, json=payload, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
package main

import (
  "bytes"
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  body := []byte(`{}`)

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/organization/network-map/icons", bytes.NewReader(body))
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.Header.Set("Content-Type", "multipart/form-data")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/organization/network-map/icons";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "multipart/form-data",
  },
  credentials: "include",
  body: JSON.stringify({}),
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

const string body = """
{}
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/organization/network-map/icons");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");
request.Content = new StringContent(body, Encoding.UTF8, "multipart/form-data");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH `/api/v1/organization/network-map/icons/{iconId}`

PATCHnetwork_map:manageshared facehosteditmspremote

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

Patch practice icon

Parameters

Name	In	Type	Required	Description
`iconId`	path	string	Yes

Request body

Required, sent as application/json.

Field	Type	Description
`matchKind`	`string or null`
`matchModel`	`string or null`
`matchVendor`	`string or null`
`name`	`string or null`

Responses

Status	Body	Description
`200`	`application/json`, DiagramIconView	Success.
`400`	`application/problem+json`, ProblemDetails	The request body is not valid JSON.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold network_map:manage.
`404`	`application/problem+json`, ProblemDetails	No such icon.
`500`	`application/problem+json`, ProblemDetails	Could not save the icon.
`503`	`application/problem+json`, ProblemDetails	Network map settings are not available on this Depot.

200 response body

Field	Type	Description
`clientId`	`string or null`
`contentType`required	`string`
`createdAt`required	`string (date-time)`
`id`required	`string`
`matchKind`	`string or null`
`matchModel`	`string or null`
`matchVendor`	`string or null`
`name`required	`string`
`url`required	`string`

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
curl -X PATCH 'https://depot.example.com/api/v1/organization/network-map/icons/<iconId>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "matchKind": "string",
  "matchModel": "string",
  "matchVendor": "string",
  "name": "string"
}'

# Sign in first. outpost_console is a session cookie, so send it with every request.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Content-Type' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$body = @'
{
  "matchKind": "string",
  "matchModel": "string",
  "matchVendor": "string",
  "name": "string"
}
'@

$response = Invoke-RestMethod `
    -Method Patch `
    -Uri 'https://depot.example.com/api/v1/organization/network-map/icons/<iconId>' `
    -Headers $headers `
    -ContentType 'application/json' `
    -Body $body

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.

import requests

url = "https://depot.example.com/api/v1/organization/network-map/icons/<iconId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "matchKind": "string",
    "matchModel": "string",
    "matchVendor": "string",
    "name": "string",
}

response = requests.patch(url, headers=headers, cookies=cookies, json=payload, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
package main

import (
  "bytes"
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  body := []byte(`{
  "matchKind": "string",
  "matchModel": "string",
  "matchVendor": "string",
  "name": "string"
}`)

  req, err := http.NewRequest(http.MethodPatch, "https://depot.example.com/api/v1/organization/network-map/icons/<iconId>", bytes.NewReader(body))
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.Header.Set("Content-Type", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/organization/network-map/icons/<iconId>";

const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify({
    "matchKind": "string",
    "matchModel": "string",
    "matchVendor": "string",
    "name": "string"
  }),
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

const string body = """
{
  "matchKind": "string",
  "matchModel": "string",
  "matchVendor": "string",
  "name": "string"
}
""";

var request = new HttpRequestMessage(HttpMethod.Patch, "https://depot.example.com/api/v1/organization/network-map/icons/<iconId>");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");
request.Content = new StringContent(body, Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE `/api/v1/organization/network-map/icons/{iconId}`

DELETEnetwork_map:manageshared facehosteditmspremoteIdempotent

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

Delete practice icon

Parameters

Name	In	Type	Required	Description
`iconId`	path	string	Yes

Responses

Status	Body	Description
`204`	None	Success, with no body.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold network_map:manage.
`404`	`application/problem+json`, ProblemDetails	No such icon.
`500`	`application/problem+json`, ProblemDetails	Could not delete the icon.
`503`	`application/problem+json`, ProblemDetails	Network map settings are not available on this Depot.

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X DELETE 'https://depot.example.com/api/v1/organization/network-map/icons/<iconId>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Delete `
    -Uri 'https://depot.example.com/api/v1/organization/network-map/icons/<iconId>' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/organization/network-map/icons/<iconId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.delete(url, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

import (
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  req, err := http.NewRequest(http.MethodDelete, "https://depot.example.com/api/v1/organization/network-map/icons/<iconId>", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/organization/network-map/icons/<iconId>";

const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Delete, "https://depot.example.com/api/v1/organization/network-map/icons/<iconId>");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET `/api/v1/organization/network-map/style`

GETdiscovery:readshared facehosteditmspremoteIdempotent

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

Get practice style

Responses

Status	Body	Description
`200`	`application/json`, PracticeStyleView	Success.
`400`	`application/problem+json`, ProblemDetails	One or more validation errors occurred.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold discovery:read.
`500`	`application/problem+json`, ProblemDetails	The request failed.

200 response body

Field	Type	Description
`defaults`required	`StyleProfile`	StyleProfile is a practice's drawing style, or a client's override of it (14.1).
`defaults.labels`	`LabelTemplate`	LabelTemplate shapes port and cable labels (18.3).
`defaults.labels.cable`	`string`
`defaults.labels.port`	`string`
`defaults.links`	`object`
`defaults.nodes`required	`LegacyNodes`	legacyNodes reads any value and keeps none of it, so it is always zero.
`defaults.sheet`	`SheetStyle`	SheetStyle is the drawing sheet's options (18.3).
`defaults.sheet.footer`	`string or null`
`defaults.sheet.legend`	`boolean or null`
`defaults.sheet.logo`	`boolean or null`
`defaults.sheet.orientation`	`string`
`defaults.sheet.paper`	`string`
`defaults.sheet.revisionTable`	`boolean or null`
`defaults.sheet.titleBlock`	`boolean or null`
`defaults.speedTiers`	`array of SpeedTier`
`defaults.speedTiers[].minMbps`required	`integer`
`defaults.speedTiers[].width`required	`number`	double.
`defaults.speedWidth`	`boolean or null`
`defaults.version`	`integer`
`profile`required	`StyleProfile`	StyleProfile is a practice's drawing style, or a client's override of it (14.1).
`profile.labels`	`LabelTemplate`	LabelTemplate shapes port and cable labels (18.3).
`profile.labels.cable`	`string`
`profile.labels.port`	`string`
`profile.links`	`object`
`profile.nodes`required	`LegacyNodes`	legacyNodes reads any value and keeps none of it, so it is always zero.
`profile.sheet`	`SheetStyle`	SheetStyle is the drawing sheet's options (18.3).
`profile.sheet.footer`	`string or null`
`profile.sheet.legend`	`boolean or null`
`profile.sheet.logo`	`boolean or null`
`profile.sheet.orientation`	`string`
`profile.sheet.paper`	`string`
`profile.sheet.revisionTable`	`boolean or null`
`profile.sheet.titleBlock`	`boolean or null`
`profile.speedTiers`	`array of SpeedTier`
`profile.speedTiers[].minMbps`required	`integer`
`profile.speedTiers[].width`required	`number`	double.
`profile.speedWidth`	`boolean or null`
`profile.version`	`integer`
`updatedAt`	`string (date-time) or null`

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/organization/network-map/style' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/organization/network-map/style' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/organization/network-map/style"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

import (
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/organization/network-map/style", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/organization/network-map/style";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/organization/network-map/style");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

PUT `/api/v1/organization/network-map/style`

PUTnetwork_map:manageshared facehosteditmspremoteIdempotent

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

Put practice style

Request body

Required, sent as application/json.

Field	Type	Description
`labels`	`LabelTemplate`	LabelTemplate shapes port and cable labels (18.3).
`labels.cable`	`string`
`labels.port`	`string`
`links`	`object`
`nodes`required	`LegacyNodes`	legacyNodes reads any value and keeps none of it, so it is always zero.
`sheet`	`SheetStyle`	SheetStyle is the drawing sheet's options (18.3).
`sheet.footer`	`string or null`
`sheet.legend`	`boolean or null`
`sheet.logo`	`boolean or null`
`sheet.orientation`	`string`
`sheet.paper`	`string`
`sheet.revisionTable`	`boolean or null`
`sheet.titleBlock`	`boolean or null`
`speedTiers`	`array of SpeedTier`
`speedTiers[].minMbps`required	`integer`
`speedTiers[].width`required	`number`	double.
`speedWidth`	`boolean or null`
`version`	`integer`

Responses

Status	Body	Description
`200`	`application/json`, PracticeStyleView	Success.
`400`	`application/problem+json`, ProblemDetails	One or more validation errors occurred.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold network_map:manage.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	Network map settings are not available on this Depot.

200 response body

Field	Type	Description
`defaults`required	`StyleProfile`	StyleProfile is a practice's drawing style, or a client's override of it (14.1).
`defaults.labels`	`LabelTemplate`	LabelTemplate shapes port and cable labels (18.3).
`defaults.labels.cable`	`string`
`defaults.labels.port`	`string`
`defaults.links`	`object`
`defaults.nodes`required	`LegacyNodes`	legacyNodes reads any value and keeps none of it, so it is always zero.
`defaults.sheet`	`SheetStyle`	SheetStyle is the drawing sheet's options (18.3).
`defaults.sheet.footer`	`string or null`
`defaults.sheet.legend`	`boolean or null`
`defaults.sheet.logo`	`boolean or null`
`defaults.sheet.orientation`	`string`
`defaults.sheet.paper`	`string`
`defaults.sheet.revisionTable`	`boolean or null`
`defaults.sheet.titleBlock`	`boolean or null`
`defaults.speedTiers`	`array of SpeedTier`
`defaults.speedTiers[].minMbps`required	`integer`
`defaults.speedTiers[].width`required	`number`	double.
`defaults.speedWidth`	`boolean or null`
`defaults.version`	`integer`
`profile`required	`StyleProfile`	StyleProfile is a practice's drawing style, or a client's override of it (14.1).
`profile.labels`	`LabelTemplate`	LabelTemplate shapes port and cable labels (18.3).
`profile.labels.cable`	`string`
`profile.labels.port`	`string`
`profile.links`	`object`
`profile.nodes`required	`LegacyNodes`	legacyNodes reads any value and keeps none of it, so it is always zero.
`profile.sheet`	`SheetStyle`	SheetStyle is the drawing sheet's options (18.3).
`profile.sheet.footer`	`string or null`
`profile.sheet.legend`	`boolean or null`
`profile.sheet.logo`	`boolean or null`
`profile.sheet.orientation`	`string`
`profile.sheet.paper`	`string`
`profile.sheet.revisionTable`	`boolean or null`
`profile.sheet.titleBlock`	`boolean or null`
`profile.speedTiers`	`array of SpeedTier`
`profile.speedTiers[].minMbps`required	`integer`
`profile.speedTiers[].width`required	`number`	double.
`profile.speedWidth`	`boolean or null`
`profile.version`	`integer`
`updatedAt`	`string (date-time) or null`

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X PUT 'https://depot.example.com/api/v1/organization/network-map/style' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "labels": {
    "cable": "string",
    "port": "string"
  },
  "links": {
    "key": {
      "arrow": false,
      "dash": "string",
      "stroke": "string",
      "width": 0
    }
  },
  "nodes": {},
  "sheet": {
    "footer": "string",
    "legend": false,
    "logo": false,
    "orientation": "string",
    "paper": "string",
    "revisionTable": false,
    "titleBlock": false
  },
  "speedTiers": [
    {
      "minMbps": 0,
      "width": 0
    }
  ],
  "speedWidth": false,
  "version": 0
}'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Content-Type' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$body = @'
{
  "labels": {
    "cable": "string",
    "port": "string"
  },
  "links": {
    "key": {
      "arrow": false,
      "dash": "string",
      "stroke": "string",
      "width": 0
    }
  },
  "nodes": {},
  "sheet": {
    "footer": "string",
    "legend": false,
    "logo": false,
    "orientation": "string",
    "paper": "string",
    "revisionTable": false,
    "titleBlock": false
  },
  "speedTiers": [
    {
      "minMbps": 0,
      "width": 0
    }
  ],
  "speedWidth": false,
  "version": 0
}
'@

$response = Invoke-RestMethod `
    -Method Put `
    -Uri 'https://depot.example.com/api/v1/organization/network-map/style' `
    -Headers $headers `
    -ContentType 'application/json' `
    -Body $body

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/organization/network-map/style"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "labels": {
        "cable": "string",
        "port": "string",
    },
    "links": {
        "key": {
            "arrow": False,
            "dash": "string",
            "stroke": "string",
            "width": 0,
        },
    },
    "nodes": {},
    "sheet": {
        "footer": "string",
        "legend": False,
        "logo": False,
        "orientation": "string",
        "paper": "string",
        "revisionTable": False,
        "titleBlock": False,
    },
    "speedTiers": [
        {
            "minMbps": 0,
            "width": 0,
        },
    ],
    "speedWidth": False,
    "version": 0,
}

response = requests.put(url, headers=headers, cookies=cookies, json=payload, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

import (
  "bytes"
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  body := []byte(`{
  "labels": {
    "cable": "string",
    "port": "string"
  },
  "links": {
    "key": {
      "arrow": false,
      "dash": "string",
      "stroke": "string",
      "width": 0
    }
  },
  "nodes": {},
  "sheet": {
    "footer": "string",
    "legend": false,
    "logo": false,
    "orientation": "string",
    "paper": "string",
    "revisionTable": false,
    "titleBlock": false
  },
  "speedTiers": [
    {
      "minMbps": 0,
      "width": 0
    }
  ],
  "speedWidth": false,
  "version": 0
}`)

  req, err := http.NewRequest(http.MethodPut, "https://depot.example.com/api/v1/organization/network-map/style", bytes.NewReader(body))
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.Header.Set("Content-Type", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/organization/network-map/style";

const response = await fetch(url, {
  method: "PUT",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify({
    "labels": {
      "cable": "string",
      "port": "string"
    },
    "links": {
      "key": {
        "arrow": false,
        "dash": "string",
        "stroke": "string",
        "width": 0
      }
    },
    "nodes": {},
    "sheet": {
      "footer": "string",
      "legend": false,
      "logo": false,
      "orientation": "string",
      "paper": "string",
      "revisionTable": false,
      "titleBlock": false
    },
    "speedTiers": [
      {
        "minMbps": 0,
        "width": 0
      }
    ],
    "speedWidth": false,
    "version": 0
  }),
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

const string body = """
{
  "labels": {
    "cable": "string",
    "port": "string"
  },
  "links": {
    "key": {
      "arrow": false,
      "dash": "string",
      "stroke": "string",
      "width": 0
    }
  },
  "nodes": {},
  "sheet": {
    "footer": "string",
    "legend": false,
    "logo": false,
    "orientation": "string",
    "paper": "string",
    "revisionTable": false,
    "titleBlock": false
  },
  "speedTiers": [
    {
      "minMbps": 0,
      "width": 0
    }
  ],
  "speedWidth": false,
  "version": 0
}
""";

var request = new HttpRequestMessage(HttpMethod.Put, "https://depot.example.com/api/v1/organization/network-map/style");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");
request.Content = new StringContent(body, Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Content is licensed CC BY 4.0. Code samples are MIT. Outpost and the Outpost mark are trademarks of Outpost Business Solutions, PBC and are not covered by either license.

Depot networkmap

GET /api/v1/clients/{clientId}/network-map/icons

Parameters

Responses

Request samples

POST /api/v1/clients/{clientId}/network-map/icons

Parameters

Request body

Responses

Request samples

PATCH /api/v1/clients/{clientId}/network-map/icons/{iconId}

Parameters

Request body

Responses

Request samples

DELETE /api/v1/clients/{clientId}/network-map/icons/{iconId}

Parameters

Responses

Request samples

GET /api/v1/clients/{clientId}/network-map/style

Parameters

Responses

Request samples

PUT /api/v1/clients/{clientId}/network-map/style

Parameters

Request body

Responses

Request samples

DELETE /api/v1/clients/{clientId}/network-map/style

Parameters

Responses

Request samples

GET /api/v1/network-map/glyphs

Responses

Request samples

GET /api/v1/network-map/icons/{iconId}

Parameters

Responses

Request samples

GET /api/v1/organization/network-map/icons

Responses

Request samples

POST /api/v1/organization/network-map/icons

Request body

Responses

Request samples

PATCH /api/v1/organization/network-map/icons/{iconId}

Parameters

Request body

Responses

Request samples

DELETE /api/v1/organization/network-map/icons/{iconId}

Parameters

Responses

Request samples

GET /api/v1/organization/network-map/style

Responses

Request samples

PUT /api/v1/organization/network-map/style

Request body

Responses

Request samples

GET `/api/v1/clients/{clientId}/network-map/icons`

POST `/api/v1/clients/{clientId}/network-map/icons`

PATCH `/api/v1/clients/{clientId}/network-map/icons/{iconId}`

DELETE `/api/v1/clients/{clientId}/network-map/icons/{iconId}`

GET `/api/v1/clients/{clientId}/network-map/style`

PUT `/api/v1/clients/{clientId}/network-map/style`

DELETE `/api/v1/clients/{clientId}/network-map/style`

GET `/api/v1/network-map/glyphs`

GET `/api/v1/network-map/icons/{iconId}`

GET `/api/v1/organization/network-map/icons`

POST `/api/v1/organization/network-map/icons`

PATCH `/api/v1/organization/network-map/icons/{iconId}`

DELETE `/api/v1/organization/network-map/icons/{iconId}`

GET `/api/v1/organization/network-map/style`

PUT `/api/v1/organization/network-map/style`