Skip to content

External Links

Operations Summary

Method Endpoint Description
GET /api/external-links/ List external links
GET /api/external-links/{uuid}/ Retrieve external link
POST /api/external-links/ Create an external link
PUT /api/external-links/{uuid}/ Update an external link
PATCH /api/external-links/{uuid}/ Partially update an external link
DELETE /api/external-links/{uuid}/ Delete an external link

Retrieve a list of external links available in the system.

1
2
3
4
http \
  GET \
  https://api.example.com/api/external-links/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.external_links import external_links_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = external_links_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: external_links_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { externalLinksList } from 'waldur-js-client';

try {
  const response = await externalLinksList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
o string Which field to use when ordering the results.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by name, link or description

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
link string (uri)
image string (uri)
created string (date-time)
modified string (date-time)

Fetch the details of a specific external link by its UUID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/external-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.external_links import external_links_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = external_links_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: external_links_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { externalLinksRetrieve } from 'waldur-js-client';

try {
  const response = await externalLinksRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
link string (uri)
image string (uri)
created string (date-time)
modified string (date-time)

Create a new external link. This action is restricted to staff users.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/external-links/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-external-link" \
  link="https://api.example.com/api/link/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.external_link_request import ExternalLinkRequest # (1)
from waldur_api_client.api.external_links import external_links_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ExternalLinkRequest(
    name="my-awesome-external-link",
    link="https://api.example.com/api/link/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = external_links_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ExternalLinkRequest
  2. API Source: external_links_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { externalLinksCreate } from 'waldur-js-client';

try {
  const response = await externalLinksCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-external-link",
    "link": "https://api.example.com/api/link/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
link string (uri) ✓
image string (binary)

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
link string (uri)
image string (uri)
created string (date-time)
modified string (date-time)

Update an existing external link. This action is restricted to staff users.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/external-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-external-link" \
  link="https://api.example.com/api/link/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.external_link_request import ExternalLinkRequest # (1)
from waldur_api_client.api.external_links import external_links_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ExternalLinkRequest(
    name="my-awesome-external-link",
    link="https://api.example.com/api/link/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = external_links_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ExternalLinkRequest
  2. API Source: external_links_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { externalLinksUpdate } from 'waldur-js-client';

try {
  const response = await externalLinksUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-external-link",
    "link": "https://api.example.com/api/link/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
link string (uri) ✓
image string (binary)

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
link string (uri)
image string (uri)
created string (date-time)
modified string (date-time)

Partially update an existing external link. This action is restricted to staff users.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/external-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_external_link_request import PatchedExternalLinkRequest # (1)
from waldur_api_client.api.external_links import external_links_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedExternalLinkRequest()
response = external_links_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedExternalLinkRequest
  2. API Source: external_links_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { externalLinksPartialUpdate } from 'waldur-js-client';

try {
  const response = await externalLinksPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string
link string (uri)
image string (binary)

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
link string (uri)
image string (uri)
created string (date-time)
modified string (date-time)

Delete an existing external link. This action is restricted to staff users.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/external-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.external_links import external_links_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = external_links_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: external_links_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { externalLinksDestroy } from 'waldur-js-client';

try {
  const response = await externalLinksDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body