Update Data Source

Update the name for a given data source ID

Endpoint

PUT /api/v1/providers/datasources/{id}

Description

Update the name for a given data source ID. This endpoint allows you to modify the display name of an existing data source.

Authentication Required

This endpoint requires a valid Veza API key for authentication.

See Authentication for more about creating and managing API keys.

All requests must include the API key as a Bearer token in the Authorization header.

Example:

curl -X GET "$BASE_URL/api/preview/keys" \
  -H "authorization: Bearer $VEZA_TOKEN"

API Reference

put

Authorizations

Path parameters

idstringRequired

Body

idstringOptional

namestringOptional

Responses

200

OK

application/json

default

Default error response

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/providers/datasources/{id} HTTP/1.1
Host: your-tenant.cookiecloud.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "id": "text",
  "name": "text"
}

{
  "value": {}
}

Path Parameters

Parameter	Type	Required?	Description
id	string	Required	The data source ID

Request Body

Field	Type	Required?	Description
name	string	Optional	New name for the data source

Request Examples

curl -X PUT "$BASE_URL/api/v1/providers/datasources/6961b032-3fd7-4baa-a230-146d1b70ec27" \
  -H "authorization: Bearer $VEZA_TOKEN" \
  -H "Content-Type: application/json" \
  --data-raw '{
    "name": "AWS EC2 Production Environment"
  }'

Response Examples

Standard Response:

{
  "value": {
    "id": "6961b032-3fd7-4baa-a230-146d1b70ec27",
    "name": "AWS EC2 Production Environment",
    "datasource_type": "EXTRACTOR",
    "agent_type": "AWS_EC2",
    "status": "SUCCESS",
    "provider_id": "cd0cf102-e86c-4599-9cbe-64d2c6b83236",
    "path": "AWS/ec2",
    "state": "ENABLED",
    "effective_state": "ENABLED",
    "datasource_config": null,
    "created_at": "2021-10-26T07:10:38Z",
    "updated_at": "2024-01-15T10:30:45Z",
    "synced_at": "2022-01-13T20:53:23Z",
    "parsed_at": "2022-01-13T20:53:29Z"
  }
}