namespaces
Overview
| Name | namespaces |
| Type | Resource |
| Id | digitalocean.functions.namespaces |
Fields
| Name | Datatype | Description |
|---|---|---|
uuid | string | The namespace's Universally Unique Identifier. |
api_host | string | The namespace's API hostname. Each function in a namespace is provided an endpoint at the namespace's hostname. |
created_at | string | UTC time string. |
key | string | A random alpha numeric string. This key is used in conjunction with the namespace's UUID to authenticate a user to use the namespace via doctl, DigitalOcean's official CLI. |
label | string | The namespace's unique name. |
namespace | string | A unique string format of UUID with a prefix fn-. |
region | string | The namespace's datacenter region. |
updated_at | string | UTC time string. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get_namespace | SELECT | namespace_id | Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID with no parameters. |
list_namespaces | SELECT | Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to /v2/functions/namespaces. | |
create_namespace | INSERT | data__label, data__region | Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to /v2/functions/namespaces with the region and label properties. |
delete_namespace | DELETE | namespace_id | Deletes the given namespace. When a namespace is deleted all assets, in the namespace are deleted, this includes packages, functions and triggers. Deleting a namespace is a destructive operation and assets in the namespace are not recoverable after deletion. Some metadata is retained, such as activations, or soft deleted for reporting purposes. To delete namespace, send a DELETE request to /v2/functions/namespaces/$NAMESPACE_ID.A successful deletion returns a 204 response. |
_get_namespace | EXEC | namespace_id | Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID with no parameters. |
_list_namespaces | EXEC | Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to /v2/functions/namespaces. |