Depot docs public

Registers the public share routes on the raw mspMux, AHEAD OF THE LICENSE GATE and beside MountSalesPublic and MountProjectsPublic.

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/public/shares/{token}

GETNo permission neededpublic facehosteditmspremoteIdempotentToken in the pathNot fully resolved

What this page does not know

• response

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

Source: [object Object]

wrap is the envelope every route wears, and it is the pipeline of section 4.4 in that order.

Parameters

Name	In	Type	Required	Description
token	path	string	Yes

Responses

Status	Body	Description
200	None	Success. The body shape was not resolved; see x-outpost-unresolved.
404	application/problem+json, ProblemDetails	This link is no longer valid. It may have expired, been used already, or been withdrawn.
413	application/problem+json, ProblemDetails	That submission is too large.
429	application/problem+json, ProblemDetails	Please wait a moment and try again.

Request samples

curl

# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/shares/<token>' \
  -H 'Accept: application/json'

PowerShell

# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'Accept' = 'application/json'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/public/shares/<token>' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

Python

# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/public/shares/<token>"
headers = {
    "Accept": "application/json",
}

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

Go

// This operation is public. It takes no credentials.
// 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/public/shares/<token>", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("Accept", "application/json")

  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))
}

TypeScript

// This operation is public. It takes no credentials.
// This operation is idempotent. Repeating it does not repeat its effect.

const url = "https://depot.example.com/api/v1/public/shares/<token>";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});

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

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

C#

// This operation is public. It takes no credentials.
// 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/public/shares/<token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");

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

POST /api/v1/public/shares/{token}/open

POSTNo permission neededpublic facehosteditmspremoteToken in the pathNot fully resolved

What this page does not know

• response

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

Source: [object Object]

wrap is the envelope every route wears, and it is the pipeline of section 4.4 in that order.

Parameters

Name	In	Type	Required	Description
token	path	string	Yes

Responses

Status	Body	Description
200	None	Success. The body shape was not resolved; see x-outpost-unresolved.
404	application/problem+json, ProblemDetails	This link is no longer valid. It may have expired, been used already, or been withdrawn.
413	application/problem+json, ProblemDetails	That submission is too large.
429	application/problem+json, ProblemDetails	Please wait a moment and try again.

Request samples

curl

# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/public/shares/<token>/open' \
  -H 'Accept: application/json'

PowerShell

# This operation is public. It takes no credentials.

$headers = @{
    'Accept' = 'application/json'
}

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/public/shares/<token>/open' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

Python

# This operation is public. It takes no credentials.

import requests

url = "https://depot.example.com/api/v1/public/shares/<token>/open"
headers = {
    "Accept": "application/json",
}

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

Go

// This operation is public. It takes no credentials.
package main

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

func main() {
  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/public/shares/<token>/open", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("Accept", "application/json")

  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))
}

TypeScript

// This operation is public. It takes no credentials.

const url = "https://depot.example.com/api/v1/public/shares/<token>/open";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "Accept": "application/json",
  },
});

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

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

C#

// This operation is public. It takes no credentials.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/public/shares/<token>/open");
request.Headers.TryAddWithoutValidation("Accept", "application/json");

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

POST /api/v1/public/shares/{token}/totp

POSTNo permission neededpublic facehosteditmspremoteToken in the pathNot fully resolved

What this page does not know

• response

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

Source: [object Object]

wrap is the envelope every route wears, and it is the pipeline of section 4.4 in that order.

Parameters

Name	In	Type	Required	Description
token	path	string	Yes

Responses

Status	Body	Description
200	None	Success. The body shape was not resolved; see x-outpost-unresolved.
404	application/problem+json, ProblemDetails	This link is no longer valid. It may have expired, been used already, or been withdrawn.
413	application/problem+json, ProblemDetails	That submission is too large.
429	application/problem+json, ProblemDetails	Please wait a moment and try again.

Request samples

curl

# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/public/shares/<token>/totp' \
  -H 'Accept: application/json'

PowerShell

# This operation is public. It takes no credentials.

$headers = @{
    'Accept' = 'application/json'
}

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/public/shares/<token>/totp' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

Python

# This operation is public. It takes no credentials.

import requests

url = "https://depot.example.com/api/v1/public/shares/<token>/totp"
headers = {
    "Accept": "application/json",
}

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

Go

// This operation is public. It takes no credentials.
package main

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

func main() {
  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/public/shares/<token>/totp", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("Accept", "application/json")

  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))
}

TypeScript

// This operation is public. It takes no credentials.

const url = "https://depot.example.com/api/v1/public/shares/<token>/totp";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "Accept": "application/json",
  },
});

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

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

C#

// This operation is public. It takes no credentials.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/public/shares/<token>/totp");
request.Headers.TryAddWithoutValidation("Accept", "application/json");

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

POST /api/v1/public/shares/{token}/verify

POSTNo permission neededpublic facehosteditmspremoteToken in the pathNot fully resolved

What this page does not know

• response

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

Source: [object Object]

wrap is the envelope every route wears, and it is the pipeline of section 4.4 in that order.

Parameters

Name	In	Type	Required	Description
token	path	string	Yes

Responses

Status	Body	Description
200	None	Success. The body shape was not resolved; see x-outpost-unresolved.
404	application/problem+json, ProblemDetails	This link is no longer valid. It may have expired, been used already, or been withdrawn.
413	application/problem+json, ProblemDetails	That submission is too large.
429	application/problem+json, ProblemDetails	Please wait a moment and try again.

Request samples

curl

# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/public/shares/<token>/verify' \
  -H 'Accept: application/json'

PowerShell

# This operation is public. It takes no credentials.

$headers = @{
    'Accept' = 'application/json'
}

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/public/shares/<token>/verify' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

Python

# This operation is public. It takes no credentials.

import requests

url = "https://depot.example.com/api/v1/public/shares/<token>/verify"
headers = {
    "Accept": "application/json",
}

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

Go

// This operation is public. It takes no credentials.
package main

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

func main() {
  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/public/shares/<token>/verify", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("Accept", "application/json")

  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))
}

TypeScript

// This operation is public. It takes no credentials.

const url = "https://depot.example.com/api/v1/public/shares/<token>/verify";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "Accept": "application/json",
  },
});

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

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

C#

// This operation is public. It takes no credentials.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/public/shares/<token>/verify");
request.Headers.TryAddWithoutValidation("Accept", "application/json");

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