Read Destination

Get destination by short name.

Args:

db: The database session short_name: The short name of the destination user: The current user

Returns:

destination (schemas.Destination): The destination

Path parameters

short_namestringRequired

Response

Successful Response

namestring

short_namestring

class_namestring

idstringformat: "uuid"

created_atdatetime

modified_atdatetime

descriptionstringOptional

auth_typeenumOptional

Enumeration of supported authentication types.

Attributes:

oauth2: OAuth2 authentication. oauth2_with_refresh: OAuth2 authentication with refresh token. oauth2_with_refresh_rotating: OAuth2 authentication with rotating refresh token. trello_auth: Trello authentication. api_key: API key authentication. native_functionality: Native functionality. url_and_api_key: URL and API key authentication. none: No authentication.

auth_config_classstringOptional

input_entity_definition_idslist of stringsOptional

organization_idstringOptionalformat: "uuid"

config_schemamap from strings to anyOptional

labelslist of stringsOptional

config_fieldsobjectOptional

Fields model.

1	from airweave import AirweaveSDK
2
3	client = AirweaveSDK(
4	api_key="YOUR_API_KEY",
5	)
6	client.destinations.read_destination(
7	short_name="short_name",
8	)

1	{
2	"name": "name",
3	"short_name": "short_name",
4	"class_name": "class_name",
5	"id": "id",
6	"created_at": "2024-01-15T09:30:00Z",
7	"modified_at": "2024-01-15T09:30:00Z",
8	"description": "description",
9	"auth_type": "oauth2",
10	"auth_config_class": "auth_config_class",
11	"input_entity_definition_ids": [
12	"input_entity_definition_ids"
13	],
14	"organization_id": "organization_id",
15	"config_schema": {
16	"key": "value"
17	},
18	"labels": [
19	"labels"
20	],
21	"config_fields": {
22	"fields": [
23	{
24	"name": "name",
25	"title": "title",
26	"type": "type"
27	}
28	]
29	}
30	}

Args:

Returns:

Path parameters

Headers

Response

Attributes:

Errors