Update Source

New
  • Published on Jun 30, 2025
  • 3 minute(s) read
Prev Next
Put
/api/1.0/paa-groups/{envId}/{paaGroupId}/sources/{sourceId}

This API is designed to update a Source in a specific PAA Group.

Notice

Accessing the APIs is through a dedicated domain/URL, according to your PlainID Tenant Location
  • United States (US) - https://API.us1.plainid.io
  • Canada (CA) - https://api.ca1.plainid.io
  • Europe (EU) - https://api.eu1.plainid.io

    • Using HTML Encoded Special Characters

    Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.


    Important note about headers

    Refer to the headers below to modify your cURL sample. Check if the following headers are in the sample, if not, ensure you add it to your cURL sample before pasting into your API tool.

    Headers

    *Required
    Header Value cURL Line
    Accept`application/json` `-H"Accept: application/json"`
    Content Type`application/json` `-H"Content-Type: application/json"`

    cURL Sample Guidelines

    In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right. They will then appear in the cURL sample on the bottom of the page in the correct format.


    Using HTML Encoded Special Characters

    Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.

    Security
    HTTP
    Type bearer

    For more details about Administration API Authentication, check out the Authentication APIs documentation
    Provide your bearer token in the Authorization header when making requests to protected resources.
    Example: Authorization: Bearer 123

    Path parameters
    envId
    string (uuid) Required

    The Environment ID can be found under the Details Tab in the Environment Settings.

    paaGroupId
    stringRequired

    The PAA Group Id

    sourceId
    stringRequired

    The Source ID

    Body parameters

    Body of the source request.

    example
    {
  "sourceId": "PIPS4BRPBO81AVPC",
  "paaGroupId": "paa1",
  "adapter": "ws",
  "name": "mockrest",
  "status": "ACTIVE",
  "description": "",
  "properties": {},
  "translator": {
    "name": "plainid-rest-iRo",
    "type": "plainid-rest",
    "properties": {
      "supportsfilter": true
    }
  },
  "models": [
    {
      "type": "PHYSICAL",
      "modelId": "PIPMM4BRPBO9U88OW",
      "paaGroupId": "paa1",
      "visible": true,
      "name": "mockrest",
      "description": "",
      "sourceIds": [
        "PIPS4BRPBO81AVPC"
      ],
      "properties": {},
      "metadata": [
        {
          "type": "DDL",
          "text": "CREATE FOREIGN TABLE context ( \n \n    uid string,\n\n    name string options (nameinsource 'name'),\n\n   city string options (nameinsource 'city'),\njwt string  \n\n) OPTIONS (nameinsource '$.Users[*]', \"plainid:method\" 'GET', \"plainid:URI\" '/users/$(uid)', \"plainid:unwrap\" 'true');"
        }
      ]
    }
  ],
  "paasProperties": [
    {
      "id": "PIMR4BRPBOE7JUGW",
      "sourceId": "PIPS4BRPBO81AVPC",
      "paaId": "PAA3QK1UON1BOXS",
      "properties": {
        "EndPoint": "http://mockserver.mockserver.svc.cluster.local:1080/json-response",
        "Password": null,
        "AuthPassword": "plainid",
        "SecurityType": "None"
      }
    }
  ]
}
    Expand All
    object
    sourceId
    string

    The parameter is relevent to the Update Sources API. Omit this parameter from the Create Source API request.

    paaGroupId
    string
    adapter
    string
    name
    string

    Source Name

    status
    string
    description
    string

    Source Description

    properties
    object
    translator
    object
    name
    string
    type
    string
    properties
    object
    models
    Array of object
    object
    type
    string
    modelId
    string

    The parameter is relevent to the Update Sources API. Omit this parameter from the Create Source API request.

    paaGroupId
    string
    visible
    boolean
    name
    string
    description
    string
    sourceIds
    Array of string

    This parameter must be null in the Create Source API.

    string
    properties
    object
    metadata
    Array of object
    object
    type
    string
    text
    string
    paasProperties
    Array of object
    object
    id
    string

    The parameter is relevant to the Update Sources API. Omit this parameter from the Create Source API request.

    sourceId
    string

    The parameter is relevant to the Update Sources API. Omit this parameter from the Create Source API request.

    paaId
    string

    The PAA ID. The PAA ID can be found in the Environment or Tenant Settings in the Policy Authorization Agent section.

    properties
    object
    Responses
    200

    Source Updated

    Headers
    x-request-id
    string
    Source Updated Successfully
    {
  "data": {
    "sourceId": "PIPS4BRPBO81AVPC",
    "paaGroupId": "paa1",
    "adapter": "ws",
    "name": "mockrest",
    "status": "ACTIVE",
    "description": "",
    "properties": {},
    "translator": {
      "name": "plainid-rest-iRo",
      "type": "plainid-rest",
      "properties": {
        "supportsfilter": true
      }
    },
    "models": [
      {
        "type": "PHYSICAL",
        "modelId": "PIPMM4BRPBO9U88OW",
        "paaGroupId": "paa1",
        "visible": true,
        "name": "mockrest",
        "description": "",
        "sourceIds": [
          "PIPS4BRPBO81AVPC"
        ],
        "properties": {},
        "metadata": [
          {
            "type": "DDL",
            "text": "CREATE FOREIGN TABLE context ( \n \n    uid string,\n\n    name string options (nameinsource 'name'),\n\n   city string options (nameinsource 'city'),\njwt string  \n\n) OPTIONS (nameinsource '$.Users[*]', \"plainid:method\" 'GET', \"plainid:URI\" '/users/$(uid)', \"plainid:unwrap\" 'false');"
          }
        ]
      }
    ],
    "paasProperties": [
      {
        "id": "PIMR4BRPBOE7JUGW",
        "sourceId": "PIPS4BRPBO81AVPC",
        "paaId": "PAA3QK1UON1BOXS",
        "properties": {
          "EndPoint": "http://mockserver.mockserver.svc.cluster.local:1080/json-response22",
          "Password": null,
          "AuthPassword": "plainid",
          "SecurityType": "None"
        }
      }
    ]
  }
}
    Expand All
    object
    data
    object
    sourceId
    string
    paaGroupId
    string
    adapter
    string
    name
    string
    status
    string
    description
    string
    properties
    object
    translator
    object
    name
    string
    type
    string
    properties
    object
    models
    Array of object
    object
    type
    string
    modelId
    string
    paaGroupId
    string
    visible
    boolean
    name
    string
    description
    string
    sourceIds
    Array of string
    string
    properties
    object
    metadata
    Array of object
    object
    type
    string
    text
    string
    paasProperties
    Array of object
    object
    id
    string
    sourceId
    string
    paaId
    string
    properties
    object
    400

    Bad Request

    Headers
    x-request-id
    string
    401

    Unauthorized

    Headers
    x-request-id
    string
    500

    Internal Server Error

    Headers
    x-request-id
    string
    The ID of the request