🗄️ Datasources
Get Datasource
🗄️ Datasources
Get Datasource
This endpoint retrieves the details of a specific Datasource by its ID.
GET
/
v1
/
datasources
/
{id}
x-metal-api-key
string
*
x-metal-api-key
Required
string
An API key for your org.
x-metal-client-id
string
*
x-metal-client-id
Required
string
A Client ID for your org.
id
string
*
id
Required
string
The unique identifier of the Datasource you wish to retrieve.
# Example Request
curl -X GET "https://api.getmetal.io/v1/datasources/{id}" \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>'
{
"data": {
"id": "datasourceID",
"createdAt": "2023-08-29T11:22:26.172Z",
"createdBy": "userID",
"name": "my_datasource",
"metadataFields": [
{
"name": "band",
"type": "string",
"description": "Which heavy metal band is represented by the iconic mascot Eddie?"
}
],
"sourcetype": "Text",
"autoExtract": false,
"createdAt": "2023-08-29T10:51:04.246Z",
"createdBy": "userId",
}
}
Auth Headers
x-metal-api-key
string
requiredAn API key for your org.
x-metal-client-id
string
requiredA Client ID for your org.
Params
id
string
requiredThe unique identifier of the Datasource you wish to retrieve.
Response
data
Datasource Object
id
string
The unique identifier of the Datasource.
name
string
Name of the Datasource.
metadataFields
array
An array of metadata fields, each with a name, type, and description.
sourcetype
string
Type of the Datasource.
autoExtract
boolean
Flag indicating whether auto-extraction is enabled or not.
createdAt
string
Timestamp indicating when the Datasource was created.
createdBy
string
ID of the user or key that created the Datasource.
# Example Request
curl -X GET "https://api.getmetal.io/v1/datasources/{id}" \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>'
{
"data": {
"id": "datasourceID",
"createdAt": "2023-08-29T11:22:26.172Z",
"createdBy": "userID",
"name": "my_datasource",
"metadataFields": [
{
"name": "band",
"type": "string",
"description": "Which heavy metal band is represented by the iconic mascot Eddie?"
}
],
"sourcetype": "Text",
"autoExtract": false,
"createdAt": "2023-08-29T10:51:04.246Z",
"createdBy": "userId",
}
}