Depot assets

View as Markdown Open in ChatGPT Open in Claude

Mounts the /assets routes and the warranty provider routes.

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/assets`

GETassets:readshared facehosteditmspIdempotent

Source: [object Object]

listAssets lists the asset register, filtered and paged.

Parameters

Name	In	Type	Required	Description
`category`	query	string, one of accessory, component, desktop, laptop, license, monitor, network, other, peripheral, phone, printer, server, tablet	No	Comma-separated set. An unrecognised value is refused.
`dir`	query	string, one of asc, desc	No	Sort direction.
`holderKind`	query	string	No
`page`	query	integer	No	One-based page number. Defaults to 1.
`pageSize`	query	integer	No	Rows per page, 1 to 200. Defaults to 50.
`q`	query	string	No	Free-text search term.
`sort`	query	string, one of name, purchased, state, tag, warranty	No	Sort key.
`state`	query	string, one of deployed, disposed, in_repair, in_stock, lost, purchased, retired, rma	No	Comma-separated set. An unrecognised value is refused.
`unlinked`	query	string	No
`warrantyBefore`	query	string	No

Responses

Status	Body	Description
`200`	`application/json`, PagedResultAssetView	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 assets:read.
`404`	`application/problem+json`, ProblemDetails	No resource matches.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`items`required	`array of AssetView`
`items[].assetTag`	`string or null`
`items[].category`required	`string`
`items[].clientId`	`string or null`
`items[].clientName`	`string or null`
`items[].createdAt`required	`string`
`items[].disposalMethod`	`string or null`
`items[].endpointAgentId`	`string or null`
`items[].endpointLinkKind`	`string or null`
`items[].endpointName`	`string or null`
`items[].holderId`	`string or null`
`items[].holderKind`	`string or null`
`items[].holderName`	`string or null`
`items[].landedCostCents`required	`integer`	int64.
`items[].manufacturer`required	`string`
`items[].model`required	`string`
`items[].name`required	`string`
`items[].notes`required	`string`
`items[].poNumber`	`string or null`
`items[].publicId`required	`string`
`items[].purchaseCostCents`required	`integer`	int64.
`items[].purchaseOrderId`	`string or null`
`items[].purchasedOn`	`string or null`
`items[].rowVersion`required	`integer`	int64.
`items[].salesOrderId`	`string or null`
`items[].salesOrderNumber`	`string or null`
`items[].serialNumber`required	`string`
`items[].siteId`	`string or null`
`items[].siteName`	`string or null`
`items[].source`required	`string`
`items[].state`required	`string`
`items[].stateChangedAt`required	`string`
`items[].stockItemId`	`string or null`
`items[].stockLocationId`	`string or null`
`items[].stockLocationName`	`string or null`
`items[].updatedAt`required	`string`
`items[].warrantyCheckedAt`	`string or null`
`items[].warrantyEndsOn`	`string or null`
`items[].warrantyError`required	`string`
`items[].warrantySource`	`string or null`
`items[].warrantyStartsOn`	`string or null`
`page`required	`integer`
`pageSize`required	`integer`
`total`required	`integer`

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/assets?category=accessory&dir=asc&holderKind=<holderKind>&page=0&pageSize=0&q=<q>' \
  -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/assets?category=accessory&dir=asc&holderKind=<holderKind>&page=0&pageSize=0&q=<q>' `
    -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/assets"
params = {
    "category": "accessory",
    "dir": "asc",
    "holderKind": "<holderKind>",
    "page": "0",
    "pageSize": "0",
    "q": "<q>",
}
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, params=params, 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/assets?category=accessory&dir=asc&holderKind=<holderKind>&page=0&pageSize=0&q=<q>", 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 = new URL("https://depot.example.com/api/v1/assets");
url.searchParams.set("category", "accessory");
url.searchParams.set("dir", "asc");
url.searchParams.set("holderKind", "<holderKind>");
url.searchParams.set("page", "0");
url.searchParams.set("pageSize", "0");
url.searchParams.set("q", "<q>");

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/assets?category=accessory&dir=asc&holderKind=<holderKind>&page=0&pageSize=0&q=<q>");
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/assets`

POSTassets:writeshared facehosteditmsp

Source: [object Object]

createAsset adds hardware to the register by hand.

Request body

Required, sent as application/json.

The body is any.

Responses

Status	Body	Description
`201`	`application/json`, AssetView	Created.
`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 assets:write.
`404`	`application/problem+json`, ProblemDetails	No resource matches.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

201 response body

Field	Type	Description
`assetTag`	`string or null`
`category`required	`string`
`clientId`	`string or null`
`clientName`	`string or null`
`createdAt`required	`string`
`disposalMethod`	`string or null`
`endpointAgentId`	`string or null`
`endpointLinkKind`	`string or null`
`endpointName`	`string or null`
`holderId`	`string or null`
`holderKind`	`string or null`
`holderName`	`string or null`
`landedCostCents`required	`integer`	int64.
`manufacturer`required	`string`
`model`required	`string`
`name`required	`string`
`notes`required	`string`
`poNumber`	`string or null`
`publicId`required	`string`
`purchaseCostCents`required	`integer`	int64.
`purchaseOrderId`	`string or null`
`purchasedOn`	`string or null`
`rowVersion`required	`integer`	int64.
`salesOrderId`	`string or null`
`salesOrderNumber`	`string or null`
`serialNumber`required	`string`
`siteId`	`string or null`
`siteName`	`string or null`
`source`required	`string`
`state`required	`string`
`stateChangedAt`required	`string`
`stockItemId`	`string or null`
`stockLocationId`	`string or null`
`stockLocationName`	`string or null`
`updatedAt`required	`string`
`warrantyCheckedAt`	`string or null`
`warrantyEndsOn`	`string or null`
`warrantyError`required	`string`
`warrantySource`	`string or null`
`warrantyStartsOn`	`string or null`

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/assets' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '"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 = @'
"string"
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/assets' `
    -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/assets"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = "string"

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(`"string"`)

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/assets", 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/assets";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify("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 = """
"string"
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/assets");
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());

GET `/api/v1/assets/{id}`

GETassets:readshared facehosteditmspIdempotent

Source: [object Object]

getAsset reads one asset.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	A uuid.

Responses

Status	Body	Description
`200`	`application/json`, AssetView	Success.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold assets:read.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`assetTag`	`string or null`
`category`required	`string`
`clientId`	`string or null`
`clientName`	`string or null`
`createdAt`required	`string`
`disposalMethod`	`string or null`
`endpointAgentId`	`string or null`
`endpointLinkKind`	`string or null`
`endpointName`	`string or null`
`holderId`	`string or null`
`holderKind`	`string or null`
`holderName`	`string or null`
`landedCostCents`required	`integer`	int64.
`manufacturer`required	`string`
`model`required	`string`
`name`required	`string`
`notes`required	`string`
`poNumber`	`string or null`
`publicId`required	`string`
`purchaseCostCents`required	`integer`	int64.
`purchaseOrderId`	`string or null`
`purchasedOn`	`string or null`
`rowVersion`required	`integer`	int64.
`salesOrderId`	`string or null`
`salesOrderNumber`	`string or null`
`serialNumber`required	`string`
`siteId`	`string or null`
`siteName`	`string or null`
`source`required	`string`
`state`required	`string`
`stateChangedAt`required	`string`
`stockItemId`	`string or null`
`stockLocationId`	`string or null`
`stockLocationName`	`string or null`
`updatedAt`required	`string`
`warrantyCheckedAt`	`string or null`
`warrantyEndsOn`	`string or null`
`warrantyError`required	`string`
`warrantySource`	`string or null`
`warrantyStartsOn`	`string 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/assets/<id>' \
  -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/assets/<id>' `
    -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/assets/<id>"
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/assets/<id>", 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/assets/<id>";

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/assets/<id>");
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());

PATCH `/api/v1/assets/{id}`

PATCHassets:writeshared facehosteditmspIdempotent

Source: [object Object]

updateAsset edits an asset’s details.

State, links and warranty lookups have their own routes. rowVersion is required.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	A uuid.

Request body

Required, sent as application/json.

The body is any.

Responses

Status	Body	Description
`200`	`application/json`, AssetView	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 assets:write.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`assetTag`	`string or null`
`category`required	`string`
`clientId`	`string or null`
`clientName`	`string or null`
`createdAt`required	`string`
`disposalMethod`	`string or null`
`endpointAgentId`	`string or null`
`endpointLinkKind`	`string or null`
`endpointName`	`string or null`
`holderId`	`string or null`
`holderKind`	`string or null`
`holderName`	`string or null`
`landedCostCents`required	`integer`	int64.
`manufacturer`required	`string`
`model`required	`string`
`name`required	`string`
`notes`required	`string`
`poNumber`	`string or null`
`publicId`required	`string`
`purchaseCostCents`required	`integer`	int64.
`purchaseOrderId`	`string or null`
`purchasedOn`	`string or null`
`rowVersion`required	`integer`	int64.
`salesOrderId`	`string or null`
`salesOrderNumber`	`string or null`
`serialNumber`required	`string`
`siteId`	`string or null`
`siteName`	`string or null`
`source`required	`string`
`state`required	`string`
`stateChangedAt`required	`string`
`stockItemId`	`string or null`
`stockLocationId`	`string or null`
`stockLocationName`	`string or null`
`updatedAt`required	`string`
`warrantyCheckedAt`	`string or null`
`warrantyEndsOn`	`string or null`
`warrantyError`required	`string`
`warrantySource`	`string or null`
`warrantyStartsOn`	`string 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 PATCH 'https://depot.example.com/api/v1/assets/<id>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '"string"'

# 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 = @'
"string"
'@

$response = Invoke-RestMethod `
    -Method Patch `
    -Uri 'https://depot.example.com/api/v1/assets/<id>' `
    -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/assets/<id>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = "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.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

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

  req, err := http.NewRequest(http.MethodPatch, "https://depot.example.com/api/v1/assets/<id>", 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/assets/<id>";

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("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.
// 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 = """
"string"
""";

var request = new HttpRequestMessage(HttpMethod.Patch, "https://depot.example.com/api/v1/assets/<id>");
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/assets/{id}`

DELETEassets:writeshared facehosteditmspIdempotent

Source: [object Object]

deleteAsset removes a hand-entered asset with no history; anything with a past is retired instead (409 assetHasHistory).

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	A uuid.

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 assets:write.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

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/assets/<id>' \
  -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/assets/<id>' `
    -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/assets/<id>"
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/assets/<id>", 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/assets/<id>";

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/assets/<id>");
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/assets/{id}/ack-link`

POSTassets:writeshared facehosteditmspIdempotent

Source: [object Object]

ackLink replaces the open checkout’s acknowledgement link and answers the new one once; the old link stops working.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	A uuid.

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 assets:write.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

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 POST 'https://depot.example.com/api/v1/assets/<id>/ack-link' \
  -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 Post `
    -Uri 'https://depot.example.com/api/v1/assets/<id>/ack-link' `
    -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/assets/<id>/ack-link"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.post(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.MethodPost, "https://depot.example.com/api/v1/assets/<id>/ack-link", 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/assets/<id>/ack-link";

const response = await fetch(url, {
  method: "POST",
  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.Post, "https://depot.example.com/api/v1/assets/<id>/ack-link");
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/assets/{id}/checkin`

POSTassets:writeshared facehosteditmspIdempotent

Source: [object Object]

checkin takes an asset back from its holder.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	A uuid.

Request body

Required, sent as application/json.

The body is any.

Responses

Status	Body	Description
`200`	`application/json`, AssetCheckoutView	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 assets:write.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`ackExpiresAt`	`string or null`
`ackRequested`required	`boolean`
`ackSignedAt`	`string or null`
`assetId`required	`string`
`assetName`required	`string`
`assetTag`	`string or null`
`checkInNote`required	`string`
`checkedInAt`	`string or null`
`checkedOutAt`required	`string`
`checkedOutByName`	`string or null`
`condition`	`string or null`
`dueBackOn`	`string or null`
`holderId`required	`string`
`holderKind`required	`string`
`holderName`	`string or null`
`publicId`required	`string`
`signerName`	`string 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 POST 'https://depot.example.com/api/v1/assets/<id>/checkin' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '"string"'

# 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 = @'
"string"
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/assets/<id>/checkin' `
    -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/assets/<id>/checkin"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = "string"

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.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

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

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/assets/<id>/checkin", 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/assets/<id>/checkin";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify("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.
// 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 = """
"string"
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/assets/<id>/checkin");
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());

POST `/api/v1/assets/{id}/checkout`

POSTassets:writeshared facehosteditmspIdempotent

Source: [object Object]

checkout hands an asset to a person.

With requestAck the answer carries a one-time acknowledgement link the holder signs.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	A uuid.

Request body

Required, sent as application/json.

The body is any.

Responses

Status	Body	Description
`200`	`application/json`, AssetCheckoutResult	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 assets:write.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`ackUrl`	`string or null`
`checkout`required	`AssetCheckoutView`
`checkout.ackExpiresAt`	`string or null`
`checkout.ackRequested`required	`boolean`
`checkout.ackSignedAt`	`string or null`
`checkout.assetId`required	`string`
`checkout.assetName`required	`string`
`checkout.assetTag`	`string or null`
`checkout.checkInNote`required	`string`
`checkout.checkedInAt`	`string or null`
`checkout.checkedOutAt`required	`string`
`checkout.checkedOutByName`	`string or null`
`checkout.condition`	`string or null`
`checkout.dueBackOn`	`string or null`
`checkout.holderId`required	`string`
`checkout.holderKind`required	`string`
`checkout.holderName`	`string or null`
`checkout.publicId`required	`string`
`checkout.signerName`	`string 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 POST 'https://depot.example.com/api/v1/assets/<id>/checkout' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '"string"'

# 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 = @'
"string"
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/assets/<id>/checkout' `
    -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/assets/<id>/checkout"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = "string"

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.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

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

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/assets/<id>/checkout", 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/assets/<id>/checkout";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify("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.
// 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 = """
"string"
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/assets/<id>/checkout");
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());

GET `/api/v1/assets/{id}/checkouts`

GETassets:readshared facehosteditmspIdempotent

Source: [object Object]

assetCheckouts is one asset’s custody history.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	A uuid.

Responses

Status	Body	Description
`200`	`application/json`, array of AssetCheckoutView	Success.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold assets:read.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`[].ackExpiresAt`	`string or null`
`[].ackRequested`required	`boolean`
`[].ackSignedAt`	`string or null`
`[].assetId`required	`string`
`[].assetName`required	`string`
`[].assetTag`	`string or null`
`[].checkInNote`required	`string`
`[].checkedInAt`	`string or null`
`[].checkedOutAt`required	`string`
`[].checkedOutByName`	`string or null`
`[].condition`	`string or null`
`[].dueBackOn`	`string or null`
`[].holderId`required	`string`
`[].holderKind`required	`string`
`[].holderName`	`string or null`
`[].publicId`required	`string`
`[].signerName`	`string 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/assets/<id>/checkouts' \
  -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/assets/<id>/checkouts' `
    -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/assets/<id>/checkouts"
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/assets/<id>/checkouts", 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/assets/<id>/checkouts";

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/assets/<id>/checkouts");
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/assets/{id}/events`

GETassets:readshared facehosteditmspIdempotent

Source: [object Object]

listEvents is an asset’s timeline, newest first.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	A uuid.

Responses

Status	Body	Description
`200`	`application/json`, array of AssetEventView	Success.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold assets:read.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`[].actorKind`required	`string`
`[].actorName`	`string or null`
`[].at`required	`string`
`[].details`required	`object`
`[].fromState`	`string or null`
`[].kind`required	`string`
`[].publicId`required	`string`
`[].toState`	`string 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/assets/<id>/events' \
  -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/assets/<id>/events' `
    -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/assets/<id>/events"
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/assets/<id>/events", 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/assets/<id>/events";

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/assets/<id>/events");
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/assets/{id}/link-endpoint`

POSTassets:writeshared facehosteditmspIdempotent

Source: [object Object]

linkEndpoint links an asset to an RMM endpoint by hand.

A manual link is never replaced by serial matching.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	A uuid.

Request body

Required, sent as application/json.

The body is any.

Responses

Status	Body	Description
`200`	`application/json`, AssetView	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 assets:write.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`assetTag`	`string or null`
`category`required	`string`
`clientId`	`string or null`
`clientName`	`string or null`
`createdAt`required	`string`
`disposalMethod`	`string or null`
`endpointAgentId`	`string or null`
`endpointLinkKind`	`string or null`
`endpointName`	`string or null`
`holderId`	`string or null`
`holderKind`	`string or null`
`holderName`	`string or null`
`landedCostCents`required	`integer`	int64.
`manufacturer`required	`string`
`model`required	`string`
`name`required	`string`
`notes`required	`string`
`poNumber`	`string or null`
`publicId`required	`string`
`purchaseCostCents`required	`integer`	int64.
`purchaseOrderId`	`string or null`
`purchasedOn`	`string or null`
`rowVersion`required	`integer`	int64.
`salesOrderId`	`string or null`
`salesOrderNumber`	`string or null`
`serialNumber`required	`string`
`siteId`	`string or null`
`siteName`	`string or null`
`source`required	`string`
`state`required	`string`
`stateChangedAt`required	`string`
`stockItemId`	`string or null`
`stockLocationId`	`string or null`
`stockLocationName`	`string or null`
`updatedAt`required	`string`
`warrantyCheckedAt`	`string or null`
`warrantyEndsOn`	`string or null`
`warrantyError`required	`string`
`warrantySource`	`string or null`
`warrantyStartsOn`	`string 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 POST 'https://depot.example.com/api/v1/assets/<id>/link-endpoint' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '"string"'

# 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 = @'
"string"
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/assets/<id>/link-endpoint' `
    -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/assets/<id>/link-endpoint"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = "string"

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.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

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

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/assets/<id>/link-endpoint", 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/assets/<id>/link-endpoint";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify("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.
// 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 = """
"string"
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/assets/<id>/link-endpoint");
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());

POST `/api/v1/assets/{id}/transition`

POSTassets:writeshared facehosteditmspIdempotent

Source: [object Object]

transition moves an asset along its state machine.

An illegal edge is 422; a state that changed since it was read is 409 stateChanged.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	A uuid.

Request body

Required, sent as application/json.

The body is any.

Responses

Status	Body	Description
`200`	`application/json`, AssetView	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 assets:write.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`assetTag`	`string or null`
`category`required	`string`
`clientId`	`string or null`
`clientName`	`string or null`
`createdAt`required	`string`
`disposalMethod`	`string or null`
`endpointAgentId`	`string or null`
`endpointLinkKind`	`string or null`
`endpointName`	`string or null`
`holderId`	`string or null`
`holderKind`	`string or null`
`holderName`	`string or null`
`landedCostCents`required	`integer`	int64.
`manufacturer`required	`string`
`model`required	`string`
`name`required	`string`
`notes`required	`string`
`poNumber`	`string or null`
`publicId`required	`string`
`purchaseCostCents`required	`integer`	int64.
`purchaseOrderId`	`string or null`
`purchasedOn`	`string or null`
`rowVersion`required	`integer`	int64.
`salesOrderId`	`string or null`
`salesOrderNumber`	`string or null`
`serialNumber`required	`string`
`siteId`	`string or null`
`siteName`	`string or null`
`source`required	`string`
`state`required	`string`
`stateChangedAt`required	`string`
`stockItemId`	`string or null`
`stockLocationId`	`string or null`
`stockLocationName`	`string or null`
`updatedAt`required	`string`
`warrantyCheckedAt`	`string or null`
`warrantyEndsOn`	`string or null`
`warrantyError`required	`string`
`warrantySource`	`string or null`
`warrantyStartsOn`	`string 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 POST 'https://depot.example.com/api/v1/assets/<id>/transition' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '"string"'

# 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 = @'
"string"
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/assets/<id>/transition' `
    -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/assets/<id>/transition"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = "string"

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.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

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

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/assets/<id>/transition", 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/assets/<id>/transition";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify("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.
// 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 = """
"string"
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/assets/<id>/transition");
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());

POST `/api/v1/assets/{id}/unlink-endpoint`

POSTassets:writeshared facehosteditmspIdempotent

Source: [object Object]

unlinkEndpoint removes the asset’s endpoint link.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	A uuid.

Responses

Status	Body	Description
`200`	`application/json`, AssetView	Success.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold assets:write.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`assetTag`	`string or null`
`category`required	`string`
`clientId`	`string or null`
`clientName`	`string or null`
`createdAt`required	`string`
`disposalMethod`	`string or null`
`endpointAgentId`	`string or null`
`endpointLinkKind`	`string or null`
`endpointName`	`string or null`
`holderId`	`string or null`
`holderKind`	`string or null`
`holderName`	`string or null`
`landedCostCents`required	`integer`	int64.
`manufacturer`required	`string`
`model`required	`string`
`name`required	`string`
`notes`required	`string`
`poNumber`	`string or null`
`publicId`required	`string`
`purchaseCostCents`required	`integer`	int64.
`purchaseOrderId`	`string or null`
`purchasedOn`	`string or null`
`rowVersion`required	`integer`	int64.
`salesOrderId`	`string or null`
`salesOrderNumber`	`string or null`
`serialNumber`required	`string`
`siteId`	`string or null`
`siteName`	`string or null`
`source`required	`string`
`state`required	`string`
`stateChangedAt`required	`string`
`stockItemId`	`string or null`
`stockLocationId`	`string or null`
`stockLocationName`	`string or null`
`updatedAt`required	`string`
`warrantyCheckedAt`	`string or null`
`warrantyEndsOn`	`string or null`
`warrantyError`required	`string`
`warrantySource`	`string or null`
`warrantyStartsOn`	`string 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 POST 'https://depot.example.com/api/v1/assets/<id>/unlink-endpoint' \
  -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 Post `
    -Uri 'https://depot.example.com/api/v1/assets/<id>/unlink-endpoint' `
    -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/assets/<id>/unlink-endpoint"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.post(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.MethodPost, "https://depot.example.com/api/v1/assets/<id>/unlink-endpoint", 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/assets/<id>/unlink-endpoint";

const response = await fetch(url, {
  method: "POST",
  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.Post, "https://depot.example.com/api/v1/assets/<id>/unlink-endpoint");
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/assets/{id}/warranty/refresh`

POSTassets:writeshared facehosteditmspIdempotent

Source: [object Object]

refreshWarranty looks the asset’s warranty up now with the practice’s provider for its manufacturer.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	A uuid.

Responses

Status	Body	Description
`200`	`application/json`, AssetView	Success.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold assets:write.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`429`	`application/problem+json`, ProblemDetails	The vendor is rate limiting lookups. Try again in a minute.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`502`	`application/problem+json`, ProblemDetails	The request was refused.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`assetTag`	`string or null`
`category`required	`string`
`clientId`	`string or null`
`clientName`	`string or null`
`createdAt`required	`string`
`disposalMethod`	`string or null`
`endpointAgentId`	`string or null`
`endpointLinkKind`	`string or null`
`endpointName`	`string or null`
`holderId`	`string or null`
`holderKind`	`string or null`
`holderName`	`string or null`
`landedCostCents`required	`integer`	int64.
`manufacturer`required	`string`
`model`required	`string`
`name`required	`string`
`notes`required	`string`
`poNumber`	`string or null`
`publicId`required	`string`
`purchaseCostCents`required	`integer`	int64.
`purchaseOrderId`	`string or null`
`purchasedOn`	`string or null`
`rowVersion`required	`integer`	int64.
`salesOrderId`	`string or null`
`salesOrderNumber`	`string or null`
`serialNumber`required	`string`
`siteId`	`string or null`
`siteName`	`string or null`
`source`required	`string`
`state`required	`string`
`stateChangedAt`required	`string`
`stockItemId`	`string or null`
`stockLocationId`	`string or null`
`stockLocationName`	`string or null`
`updatedAt`required	`string`
`warrantyCheckedAt`	`string or null`
`warrantyEndsOn`	`string or null`
`warrantyError`required	`string`
`warrantySource`	`string or null`
`warrantyStartsOn`	`string 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 POST 'https://depot.example.com/api/v1/assets/<id>/warranty/refresh' \
  -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 Post `
    -Uri 'https://depot.example.com/api/v1/assets/<id>/warranty/refresh' `
    -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/assets/<id>/warranty/refresh"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.post(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.MethodPost, "https://depot.example.com/api/v1/assets/<id>/warranty/refresh", 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/assets/<id>/warranty/refresh";

const response = await fetch(url, {
  method: "POST",
  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.Post, "https://depot.example.com/api/v1/assets/<id>/warranty/refresh");
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/assets/checkouts`

GETassets:readshared facehosteditmspIdempotent

Source: [object Object]

listCheckouts lists custody periods by holder: the People equipment panel.

Parameters

Name	In	Type	Required
`holder`	query	string	No
`holderKind`	query	string	No
`open`	query	string	No

Responses

Status	Body	Description
`200`	`application/json`, array of AssetCheckoutView	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 assets:read.
`404`	`application/problem+json`, ProblemDetails	No resource matches.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`[].ackExpiresAt`	`string or null`
`[].ackRequested`required	`boolean`
`[].ackSignedAt`	`string or null`
`[].assetId`required	`string`
`[].assetName`required	`string`
`[].assetTag`	`string or null`
`[].checkInNote`required	`string`
`[].checkedInAt`	`string or null`
`[].checkedOutAt`required	`string`
`[].checkedOutByName`	`string or null`
`[].condition`	`string or null`
`[].dueBackOn`	`string or null`
`[].holderId`required	`string`
`[].holderKind`required	`string`
`[].holderName`	`string or null`
`[].publicId`required	`string`
`[].signerName`	`string 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/assets/checkouts?holder=<holder>&holderKind=<holderKind>&open=<open>' \
  -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/assets/checkouts?holder=<holder>&holderKind=<holderKind>&open=<open>' `
    -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/assets/checkouts"
params = {
    "holder": "<holder>",
    "holderKind": "<holderKind>",
    "open": "<open>",
}
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, params=params, 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/assets/checkouts?holder=<holder>&holderKind=<holderKind>&open=<open>", 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 = new URL("https://depot.example.com/api/v1/assets/checkouts");
url.searchParams.set("holder", "<holder>");
url.searchParams.set("holderKind", "<holderKind>");
url.searchParams.set("open", "<open>");

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/assets/checkouts?holder=<holder>&holderKind=<holderKind>&open=<open>");
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/assets/forecast`

GETassets:readshared facehosteditmspIdempotent

Source: [object Object]

forecast lists hardware due for replacement: warranty ending within the horizon (or already ended) or older than the practice’s refresh age.

Parameters

Name	In	Type	Required	Description
`horizonDays`	query	string	No

Responses

Status	Body	Description
`200`	`application/json`, array of AssetForecastView	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 assets:read.
`404`	`application/problem+json`, ProblemDetails	No resource matches.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`[].asset`required	`AssetView`
`[].asset.assetTag`	`string or null`
`[].asset.category`required	`string`
`[].asset.clientId`	`string or null`
`[].asset.clientName`	`string or null`
`[].asset.createdAt`required	`string`
`[].asset.disposalMethod`	`string or null`
`[].asset.endpointAgentId`	`string or null`
`[].asset.endpointLinkKind`	`string or null`
`[].asset.endpointName`	`string or null`
`[].asset.holderId`	`string or null`
`[].asset.holderKind`	`string or null`
`[].asset.holderName`	`string or null`
`[].asset.landedCostCents`required	`integer`	int64.
`[].asset.manufacturer`required	`string`
`[].asset.model`required	`string`
`[].asset.name`required	`string`
`[].asset.notes`required	`string`
`[].asset.poNumber`	`string or null`
`[].asset.publicId`required	`string`
`[].asset.purchaseCostCents`required	`integer`	int64.
`[].asset.purchaseOrderId`	`string or null`
`[].asset.purchasedOn`	`string or null`
`[].asset.rowVersion`required	`integer`	int64.
`[].asset.salesOrderId`	`string or null`
`[].asset.salesOrderNumber`	`string or null`
`[].asset.serialNumber`required	`string`
`[].asset.siteId`	`string or null`
`[].asset.siteName`	`string or null`
`[].asset.source`required	`string`
`[].asset.state`required	`string`
`[].asset.stateChangedAt`required	`string`
`[].asset.stockItemId`	`string or null`
`[].asset.stockLocationId`	`string or null`
`[].asset.stockLocationName`	`string or null`
`[].asset.updatedAt`required	`string`
`[].asset.warrantyCheckedAt`	`string or null`
`[].asset.warrantyEndsOn`	`string or null`
`[].asset.warrantyError`required	`string`
`[].asset.warrantySource`	`string or null`
`[].asset.warrantyStartsOn`	`string or null`
`[].dueOn`required	`string`
`[].reason`required	`string`

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/assets/forecast?horizonDays=<horizonDays>' \
  -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/assets/forecast?horizonDays=<horizonDays>' `
    -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/assets/forecast"
params = {
    "horizonDays": "<horizonDays>",
}
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, params=params, 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/assets/forecast?horizonDays=<horizonDays>", 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 = new URL("https://depot.example.com/api/v1/assets/forecast");
url.searchParams.set("horizonDays", "<horizonDays>");

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/assets/forecast?horizonDays=<horizonDays>");
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/assets/returns`

GETassets:readshared facehosteditmspIdempotent

Source: [object Object]

listReturns lists equipment owed back by disabled or offboarded people.

Parameters

Name	In	Type	Required	Description
`open`	query	string	No

Responses

Status	Body	Description
`200`	`application/json`, array of EquipmentReturnView	Success.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold assets:read.
`404`	`application/problem+json`, ProblemDetails	No resource matches.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`[].assetIds`required	`array of string`
`[].closedAt`	`string or null`
`[].holderId`required	`string`
`[].holderKind`required	`string`
`[].holderName`	`string or null`
`[].openedAt`required	`string`
`[].publicId`required	`string`
`[].reason`required	`string`
`[].ticketId`	`string or null`
`[].ticketReference`	`string 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/assets/returns?open=<open>' \
  -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/assets/returns?open=<open>' `
    -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/assets/returns"
params = {
    "open": "<open>",
}
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, params=params, 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/assets/returns?open=<open>", 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 = new URL("https://depot.example.com/api/v1/assets/returns");
url.searchParams.set("open", "<open>");

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/assets/returns?open=<open>");
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/assets/returns/{id}/close`

POSTassets:writeshared facehosteditmspIdempotent

Source: [object Object]

closeReturn marks an equipment return as settled.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	A uuid.

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 assets:write.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

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 POST 'https://depot.example.com/api/v1/assets/returns/<id>/close' \
  -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 Post `
    -Uri 'https://depot.example.com/api/v1/assets/returns/<id>/close' `
    -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/assets/returns/<id>/close"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.post(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.MethodPost, "https://depot.example.com/api/v1/assets/returns/<id>/close", 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/assets/returns/<id>/close";

const response = await fetch(url, {
  method: "POST",
  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.Post, "https://depot.example.com/api/v1/assets/returns/<id>/close");
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/integrations/warranty-providers`

GETshared facehosteditmspIdempotent

Source: [object Object]

listWarrantyProviders lists the Dell, Lenovo and HP warranty connections.

Responses

Status	Body	Description
`200`	`application/json`, array of WarrantyProviderView	Success.
`404`	`application/problem+json`, ProblemDetails	No resource matches.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`[].credentialId`	`string or null`
`[].credentialName`	`string or null`
`[].enabled`required	`boolean`
`[].lastCheckAt`	`string or null`
`[].lastError`required	`string`
`[].lastErrorKind`	`string or null`
`[].publicId`required	`string`
`[].rowVersion`required	`integer`	int64.
`[].vendor`required	`string`

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/integrations/warranty-providers' \
  -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/integrations/warranty-providers' `
    -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/integrations/warranty-providers"
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/integrations/warranty-providers", 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/integrations/warranty-providers";

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/integrations/warranty-providers");
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/integrations/warranty-providers/{vendor}`

PUTintegrations:adminshared facehosteditmspIdempotent

Source: [object Object]

putWarrantyProvider sets a vendor’s warranty connection: which vault credential it signs in with, and whether lookups run.

Parameters

Name	In	Type	Required	Description
`vendor`	path	string	Yes

Request body

Required, sent as application/json.

The body is any.

Responses

Status	Body	Description
`200`	`application/json`, WarrantyProviderView	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 integrations:admin.
`404`	`application/problem+json`, ProblemDetails	Warranty connections are for dell, lenovo and hp.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

200 response body

Field	Type	Description
`credentialId`	`string or null`
`credentialName`	`string or null`
`enabled`required	`boolean`
`lastCheckAt`	`string or null`
`lastError`required	`string`
`lastErrorKind`	`string or null`
`publicId`required	`string`
`rowVersion`required	`integer`	int64.
`vendor`required	`string`

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/integrations/warranty-providers/<vendor>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '"string"'

# 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 = @'
"string"
'@

$response = Invoke-RestMethod `
    -Method Put `
    -Uri 'https://depot.example.com/api/v1/integrations/warranty-providers/<vendor>' `
    -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/integrations/warranty-providers/<vendor>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = "string"

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(`"string"`)

  req, err := http.NewRequest(http.MethodPut, "https://depot.example.com/api/v1/integrations/warranty-providers/<vendor>", 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/integrations/warranty-providers/<vendor>";

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("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.
// 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 = """
"string"
""";

var request = new HttpRequestMessage(HttpMethod.Put, "https://depot.example.com/api/v1/integrations/warranty-providers/<vendor>");
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/integrations/warranty-providers/{vendor}`

DELETEintegrations:adminshared facehosteditmspIdempotent

Source: [object Object]

deleteWarrantyProvider removes a vendor’s warranty connection.

Parameters

Name	In	Type	Required	Description
`vendor`	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 integrations:admin.
`404`	`application/problem+json`, ProblemDetails	Warranty connections are for dell, lenovo and hp.
`409`	`application/problem+json`, ProblemDetails	That change conflicts with the current state.
`412`	`application/problem+json`, ProblemDetails	This asset changed since it was read. Reload and try again.
`500`	`application/problem+json`, ProblemDetails	The request failed.
`503`	`application/problem+json`, ProblemDetails	This Depot has no database for this request yet.

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/integrations/warranty-providers/<vendor>' \
  -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/integrations/warranty-providers/<vendor>' `
    -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/integrations/warranty-providers/<vendor>"
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/integrations/warranty-providers/<vendor>", 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/integrations/warranty-providers/<vendor>";

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/integrations/warranty-providers/<vendor>");
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());

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 assets

GET /api/v1/assets

Parameters

Responses

Request samples

POST /api/v1/assets

Request body

Responses

Request samples

GET /api/v1/assets/{id}

Parameters

Responses

Request samples

PATCH /api/v1/assets/{id}

Parameters

Request body

Responses

Request samples

DELETE /api/v1/assets/{id}

Parameters

Responses

Request samples

POST /api/v1/assets/{id}/ack-link

Parameters

Responses

Request samples

POST /api/v1/assets/{id}/checkin

Parameters

Request body

Responses

Request samples

POST /api/v1/assets/{id}/checkout

Parameters

Request body

Responses

Request samples

GET /api/v1/assets/{id}/checkouts

Parameters

Responses

Request samples

GET /api/v1/assets/{id}/events

Parameters

Responses

Request samples

POST /api/v1/assets/{id}/link-endpoint

Parameters

Request body

Responses

Request samples

POST /api/v1/assets/{id}/transition

Parameters

Request body

Responses

Request samples

POST /api/v1/assets/{id}/unlink-endpoint

Parameters

Responses

Request samples

POST /api/v1/assets/{id}/warranty/refresh

Parameters

Responses

Request samples

GET /api/v1/assets/checkouts

Parameters

Responses

Request samples

GET /api/v1/assets/forecast

Parameters

Responses

Request samples

GET /api/v1/assets/returns

Parameters

Responses

Request samples

POST /api/v1/assets/returns/{id}/close

Parameters

Responses

Request samples

GET /api/v1/integrations/warranty-providers

Responses

GET `/api/v1/assets`

POST `/api/v1/assets`

GET `/api/v1/assets/{id}`

PATCH `/api/v1/assets/{id}`

DELETE `/api/v1/assets/{id}`

POST `/api/v1/assets/{id}/ack-link`

POST `/api/v1/assets/{id}/checkin`

POST `/api/v1/assets/{id}/checkout`

GET `/api/v1/assets/{id}/checkouts`

GET `/api/v1/assets/{id}/events`

POST `/api/v1/assets/{id}/link-endpoint`

POST `/api/v1/assets/{id}/transition`

POST `/api/v1/assets/{id}/unlink-endpoint`

POST `/api/v1/assets/{id}/warranty/refresh`

GET `/api/v1/assets/checkouts`

GET `/api/v1/assets/forecast`

GET `/api/v1/assets/returns`

POST `/api/v1/assets/returns/{id}/close`

GET `/api/v1/integrations/warranty-providers`

PUT `/api/v1/integrations/warranty-providers/{vendor}`

DELETE `/api/v1/integrations/warranty-providers/{vendor}`