Connectors

Rename a connector

Rename a connector by updating its display name. The connector ID is unchanged.

patch/v1beta/connectors/{connector_id}

Request

  • Base URL: https://api.indices.io
  • URL: https://api.indices.io/v1beta/connectors/{connector_id}
  • Auth: HTTP bearer

Path parameters

connector_idstring required

The ID of the connector to rename.

Request body

display_namestring required

Short human-readable name of the connector.

Example request

{
  "display_name": "Invoice retrieval"
}

Response

Successful response

idstring required

Unique identifier for the object.

display_namestring required

Short human-readable name of the connector.

purposestring required

What the connector does, as specified at publish time.

websitestring nullable required

Website the connector operates against.

input_schemaobject required

JSON Schema for the connector's run arguments.

output_schemaobject required

JSON Schema for the connector's run results.

versioninteger required

Version of the connector, starting at 1 and incremented by each revision.

created_atstring date-time required

Timestamp when the object was created.

Example response

{
  "id": "conn_8kPq2mWxYz1aBcDeFgHi3J",
  "display_name": "Invoice retrieval",
  "purpose": "Retrieve invoices from our ERP system, including refunds.",
  "website": "https://example.com",
  "required_secrets": [
    {
      "name": "amazon_login",
      "description": "Amazon account whose orders are fetched."
    }
  ],
  "version": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.