Get Source by ID

  • Updated on Jun 8, 2025
  • 2 minute(s) read
Prev Next
Get
/api/1.0/paa-groups/{envId}/{paaGroup}/sources/{sourceId}

This API is is designed to retrieve Sources from 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"`

    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.

    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.

    paaGroup
    stringRequired

    The PAA Group Name

    sourceId
    stringRequired

    The Source ID

    Responses
    200

    Source Retrieved

    Headers
    x-request-id
    string
    Source Retrieved Successfully
    {
  "data": {
    "sourceId": "PIPS44BQJIJ2X3WG",
    "paaGroupId": "paa1",
    "adapter": "ws",
    "name": "auditadmin",
    "status": "ACTIVE",
    "description": "",
    "properties": {},
    "translator": {
      "name": "plainid-rest-tqK",
      "type": "plainid-rest",
      "properties": {
        "authConf": "/app/conf/auth-config.xml",
        "securityDomain": "oauth2-plainid-m-api",
        "supportsfilter": true
      }
    },
    "models": [
      {
        "type": "PHYSICAL",
        "modelId": "PIPMM44BQJIKBVA4G",
        "paaGroupId": "paa1",
        "visible": true,
        "name": "AdminAuditData",
        "description": "",
        "sourceIds": [
          "PIPS44BQJIJ2X3WG"
        ],
        "properties": {},
        "metadata": [
          {
            "type": "DDL",
            "text": "CREATE FOREIGN TABLE AdminAuditData (\nid string,\naction string,\nusreId string,\nresourceType string,\nresourceId string,\nresourceName string,\noff_set integer default 0\n) OPTIONS (nameinsource '$.data[*]', \"plainid:unwrap\" 'false' , \"plainid:method\" 'GET', \"plainid:URI\" '593f15f6-665e-4645-8293-35e41013c610?offset=0&limit=50');"
          }
        ]
      }
    ],
    "paasProperties": [
      {
        "id": "PIMR44BQJIYJSGZK",
        "sourceId": "PIPS44BQJIJ2X3WG",
        "paaId": "PAA3QK1UON1BOXS",
        "properties": {
          "EndPoint": "https://api.us1.plainid.io/api/1.0/audit-admin/",
          "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