Skip to content

Keys

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/keys/ List Keys
GET /api/keys/{uuid}/ Retrieve
POST /api/keys/ Create
DELETE /api/keys/{uuid}/ Delete
Other Actions
GET /api/keys/{uuid}/history/at/ Get object state at a specific timestamp
GET /api/keys/{uuid}/history/ Get version history

Core CRUD

List Keys

1
2
3
4
http \
  GET \
  https://api.example.com/api/keys/ \
  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.models.ssh_key_field_enum import SshKeyFieldEnum # (1)
from waldur_api_client.models.ssh_key_o_enum import SshKeyOEnum # (2)
from waldur_api_client.api.keys import keys_list # (3)

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

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

try {
  const response = await keysList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
created_before string (date-time) Created before
field array
fingerprint_md5 string
fingerprint_sha256 string
fingerprint_sha512 string
is_shared boolean
modified string (date-time) Modified after
modified_before string (date-time) Modified before
name string Name
name_exact string Name (exact)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user_uuid string (uuid) User UUID
uuid string (uuid) UUID

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
public_key string
fingerprint_md5 string
fingerprint_sha256 string
fingerprint_sha512 string
user_uuid string (uuid)
is_shared boolean
type string

Retrieve

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.ssh_key_field_enum import SshKeyFieldEnum # (1)
from waldur_api_client.api.keys import keys_retrieve # (2)

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

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

try {
  const response = await keysRetrieve({
  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) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
public_key string
fingerprint_md5 string
fingerprint_sha256 string
fingerprint_sha512 string
user_uuid string (uuid)
is_shared boolean
type string

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/keys/ \
  Authorization:"Token YOUR_API_TOKEN" \
  public_key="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.ssh_key_request import SshKeyRequest # (1)
from waldur_api_client.api.keys import keys_create # (2)

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

body_data = SshKeyRequest(
    public_key="string-value"
)
response = keys_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await keysCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "public_key": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string
public_key string ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
public_key string
fingerprint_md5 string
fingerprint_sha256 string
fingerprint_sha512 string
user_uuid string (uuid)
is_shared boolean
type string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/keys/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.keys import keys_destroy # (1)

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

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

try {
  const response = await keysDestroy({
  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

Other Actions

Get object state at a specific timestamp

Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/keys/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/at/ \
  Authorization:"Token YOUR_API_TOKEN" \
  timestamp=="string-value"

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

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

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

try {
  const response = await keysHistoryAtRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "timestamp": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Required Description
timestamp string ✓ ISO 8601 timestamp to query the object state at

200 -

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

400 -

404 -

Get version history

Returns the version history for this object. Only accessible by staff and support users.

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.ssh_key_o_enum import SshKeyOEnum # (1)
from waldur_api_client.api.keys import keys_history_list # (2)

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

for item in response:
    print(item)
  1. Model Source: SshKeyOEnum
  2. API Source: keys_history_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { keysHistoryList } from 'waldur-js-client';

try {
  const response = await keysHistoryList({
  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) ✓
Name Type Description
created string (date-time) Created after
created_after string Filter versions created after this timestamp (ISO 8601)
created_before string Filter versions created before this timestamp (ISO 8601)
fingerprint_md5 string
fingerprint_sha256 string
fingerprint_sha512 string
is_shared boolean
modified string (date-time) Modified after
modified_before string (date-time) Modified before
name string Name
name_exact string Name (exact)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user_uuid string (uuid) User UUID
uuid string (uuid) UUID

200 -

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

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision