Create Source

Prev Next
Post
/api/1.0/paa-groups/{envId}/{paaGroupId}/sources

This API call is designed to create a Source in a PAA Group and deploy it to the PAAs of the group.

Rules

  • Do not send `sourceId`. The API generates it, and returns `400` when the body has a `sourceId`.
  • `paaGroupId` is optional. If you send it, it must be equal to the `paaGroupId` path parameter.
  • `name` must be unique in the PAA Group.
  • `translator.type` selects the data source type and the adapter. See `PaaSourceTranslator` for the supported values. An unknown value gives `404`.
  • `paasProperties` is required. Send one item for each PAA that connects to the data source. Each `paaId` must be a PAA of this PAA Group.
  • In each model, set `type` to `PHYSICAL`. Do not send `modelId`, `sourceIds` or `paaGroupId`; the API sets them.
  • The API ignores `adapter` and `status`. A new Source always has the status `ACTIVE`.
  • The API deploys the Source to each PAA in `paasProperties`. If the deployment fails on all of these PAAs, the API returns `400` and does not create the Source.

Notice

Accessing the API call 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.

    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
    stringRequired

    The Environment ID (a UUID). You can find it in the Details tab of the Environment Settings. If your PAA is installed on the Tenant level, use - as the envId.

    Example2d4a0591-dfe4-45fb-8a69-d183f5c75c0d
    paaGroupId
    stringRequired

    The PAA Group ID, as the List PAA Groups API returns it in id.

    Examplepaa1
    Body parameters

    The new Source.

    example
    {
      "paaGroupId": "paa1",
      "adapter": "ws",
      "name": "mockrest2",
      "status": "ACTIVE",
      "description": "",
      "properties": {},
      "translator": {
        "name": "plainid-rest-iRo",
        "type": "plainid-rest",
        "properties": {
          "supportsfilter": "true"
        }
      },
      "models": [
        {
          "type": "PHYSICAL",
          "paaGroupId": "paa1",
          "visible": true,
          "name": "mockrest",
          "description": "",
          "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": [
        {
          "paaId": "PAA3QK1UON1BOXS",
          "properties": {
            "EndPoint": "https://api.your-company.com/endpoint",
            "Password": null,
            "SecurityType": "None"
          }
        }
      ]
    }
    Expand All
    object

    Do not send sourceId. The API returns 400 when the body has a sourceId. Keep the values in the patterns and the length limits of this schema. The API does not check all of them.

    paaGroupId
    string

    Optional. If you send it, it must be equal to the paaGroupId path parameter.

    Examplepaa1
    name
    string Required

    The Source name. It must be unique in the PAA Group. The PAA uses it as the data source name, so use letters, digits and the characters _ - / # . only.

    Max length255
    Pattern^[a-zA-Z0-9_\-\/#\.]+$
    Examplemockrest
    description
    string

    The Source description.

    Max length4096
    Default""
    translator
    object (PaaSourceTranslator) Required

    The Teiid translator of the Source. type selects the data source type and the adapter (the connection type) of the Source. The adapter sets the keys of properties and of paasProperties[].properties:

    typeData sourceAdapter
    jdbc-simpleSimple JDBCjdbc
    mysqlMySQLjdbc
    postgresqlPostgreSQLjdbc
    sqlserverMicrosoft SQL Serverjdbc
    oracleOraclejdbc
    db2IBM DB2jdbc
    sybaseSybasejdbc
    ldapLDAPldap
    mongodbMongoDBmongodb
    plainid-mongodbMongoDB (new)plainid-mongodb
    salesforce-41Salesforce (API 41.0)salesforce
    odata4OData v4.0ws
    plainid-restRESTws
    plainid-scimSCIMws
    plainid-azureAzure Active Directoryws
    type
    string Required

    The translator type. The API compares it without case sensitivity. An unknown value gives 404.

    Valid values[ "jdbc-simple", "mysql", "postgresql", "sqlserver", "oracle", "db2", "sybase", "ldap", "mongodb", "plainid-mongodb", "salesforce-41", "odata4", "plainid-rest", "plainid-scim", "plainid-azure" ]
    Exampleplainid-rest
    name
    string

    The name of the translator instance. When name is empty or omitted, the API uses the value of type. When you also send properties, the API makes a unique name in the form <type>-<3 letters>, for example plainid-rest-iRo.

    Exampleplainid-rest-iRo
    properties
    object

    Translator override properties (Teiid translator settings), for example supportsfilter. All values are strings.

    Example{ "supportsfilter": "true" }
    property*
    string additionalProperties
    properties
    object (PaaSourceProperties)

    Source-level connection properties. The keys depend on the adapter of the Source, and the adapter depends on translator.type (see PaaSourceTranslator). The values are strings, numbers or booleans. Keys that are specific to one PAA go in paasProperties[].properties.

    AnyOf
    PaaSourcePropertiesJdbc
    object (PaaSourcePropertiesJdbc)
    DriverClassName
    string Required
    Min length2
    Max length1024
    ConnectionInitSqls
    string
    Max length1024
    ConnectionProperties
    string
    Max length1024
    DefaultReadOnly
    boolean
    InitialSize
    number
    Default2
    DefaultSchema
    string
    Max length1024
    MaxTotal
    number
    MaxIdle
    number
    Default10
    MaxConnLifetimeMillis
    number
    MaxOpenPreparedStatements
    number
    Default100
    MinIdle
    number
    Default5
    PoolPreparedStatements
    boolean
    ValidationQuery
    string
    Max length1024
    Default"SELECT 1"
    IsTransactional
    boolean
    Defaultfalse
    SocketProcessIdPort
    string
    Default"0"
    SocketProcessIdMaxPorts
    number
    Default10
    EnableStatistics
    boolean
    Defaultfalse
    DefaultTimeout
    number
    Default300
    TransactionStatusManagerEnable
    boolean
    Defaultfalse
    TxReaperTimeout
    number
    Default120000
    PaaSourcePropertiesLdap
    object (PaaSourcePropertiesLdap)
    LdapContextFactory
    string
    Max length1024
    LdapTxnTimeoutInMillis
    number
    PaaSourcePropertiesMongodb
    object (PaaSourcePropertiesMongodb)
    AuthDatabase
    string
    Max length2048
    SecurityType
    string
    Valid values[ "None", "SCRAM_SHA_1", "SCRAM_SHA_256", "MONGODB_CR", "Kerberos", "X509" ]
    Default"SCRAM_SHA_1"
    Ssl
    boolean
    Defaultfalse
    PaaSourcePropertiesSalesforce
    object (PaaSourcePropertiesSalesforce)
    ConfigProperties
    string
    Max length4096
    ConnectTimeout
    number
    RequestTimeout
    number
    PaaSourcePropertiesWs
    object (PaaSourcePropertiesWs)
    ConfigFile
    string
    Max length1024
    ConfigName
    string
    Max length1024
    AuthConf
    string
    Max length1024
    ServiceName
    string
    Max length1024
    NamespaceUri
    string
    Max length1024
    RequestTimeout
    number
    ConnectTimeout
    number
    Wsdl
    string
    Max length1024
    PaaSourcePropertiesPlainidMongodb
    object (PaaSourcePropertiesPlainidMongodb)
    AuthDatabase
    string
    Max length2048
    SecurityType
    string
    Valid values[ "None", "SCRAM_SHA_1", "SCRAM_SHA_256", "MONGODB_CR", "Kerberos", "X509" ]
    Default"SCRAM_SHA_1"
    Ssl
    boolean
    Defaultfalse
    models
    Array of object (PaaSourceModelRequest)

    The models (schemas) of the Source. Set type to PHYSICAL and do not send modelId.

    object
    type
    string Required

    Always send PHYSICAL. The models of a Source are physical models. The API rejects a Source model without type.

    Valid values[ "PHYSICAL" ]
    ExamplePHYSICAL
    modelId
    string

    Update Source only. Send the modelId of an existing model to update that model. Omit it to create a new model. Do not send it in the Create Source API.

    visible
    boolean

    When false, clients cannot query the model directly. Views can still use it.

    Defaulttrue
    name
    string Required

    The model name (the schema name in the PAA). Use letters, digits and the characters `_ - /

    Max length255
    Pattern^[a-zA-Z0-9_\-\/#\.]+$
    description
    string

    The model description.

    Max length4096
    properties
    object

    Model properties. The values are strings, numbers or booleans.

    metadata
    Array of object (PaaModelMetadata) Required

    The model definition, usually one DDL item with the CREATE FOREIGN TABLE statements.

    Min items1
    object
    type
    string Required

    The Teiid metadata type of text. Use DDL (Teiid DDL, for example CREATE FOREIGN TABLE or CREATE VIEW).

    Valid values[ "DDL", "NATIVE", "DDL-FILE", "UDF" ]
    Default"DDL"
    paaId
    string

    The PAA that this metadata applies to. Omit it for metadata that applies to all of the PAAs in the group.

    Pattern^PAA[0-9A-Z]{11,13}$
    text
    string Required

    The metadata text, for example a Teiid DDL statement.

    Max length1000000
    paaGroupId
    string

    The API ignores this value and sets it.

    sourceIds
    Array of string

    The API ignores this value and sets it.

    string
    paasProperties
    Array of object (PaaSourcePaaPropertiesRequest) Required

    The connection properties for each PAA. Send one item for each PAA that connects to the data source. The API deploys the Source to these PAAs.

    object
    paaId
    string Required

    The PAA ID. The PAA must be in the PAA Group. You can find the PAA ID in the Environment or Tenant Settings, in the Policy Authorization Agent section, or in the List PAA Groups API (detailed=true).

    Pattern^PAA[0-9A-Z]{11,13}$
    ExamplePAA3QK1UON1BOXS
    id
    string

    Update Source only, optional. The id that the Get Source by ID API returns for this PAA. Do not send it in the Create Source API.

    sourceId
    string

    Update Source only, optional. Do not send it in the Create Source API.

    properties
    object (PaaConnectionProperties) Required

    Connection properties for one PAA. The keys depend on the adapter of the Source, and the adapter depends on translator.type (see PaaSourceTranslator). The values are strings, numbers or booleans.

    Password: responses return null for a stored password, except for a secret reference in the form [NAME] or {{NAME}}, which the API returns as is. On update, send null (or omit the key) to keep the stored password of that PAA.

    AnyOf
    PaaConnectionPropertiesJdbc
    object (PaaConnectionPropertiesJdbc)
    Url
    string (uri) Required
    Min length2
    Max length1024
    Username
    string
    Max length1024
    Password
    string (password)
    Max length1024
    AuthConf
    string
    Max length1024
    SecurityDomain
    string
    Max length1024
    PaaConnectionPropertiesLdap
    object (PaaConnectionPropertiesLdap)
    LdapUrl
    string (uri) Required
    Min length2
    LdapAdminUserDN
    string
    Max length1024
    LdapAdminUserPassword
    string (password)
    Max length1024
    LdapAuthType
    string
    Max length1024
    PaaConnectionPropertiesMongodb
    object (PaaConnectionPropertiesMongodb)
    RemoteServerList
    string Required
    Min length2
    Max length2048
    Database
    string Required
    Max length1024
    Username
    string
    Max length1024
    Password
    string (password)
    Max length1024
    PaaConnectionPropertiesSalesforce
    object (PaaConnectionPropertiesSalesforce)
    URL
    string (uri)
    Max length4096
    Username
    string Required
    Max length1024
    Password
    string (password)
    Max length1024
    ProxyURL
    string (uri)
    Max length1024
    ProxyUsername
    string
    Max length1024
    ProxyPassword
    string (password)
    Max length1024
    PaaConnectionPropertiesWs
    object (PaaConnectionPropertiesWs)
    EndPoint
    string
    Max length1024
    SecurityType
    string
    Valid values[ "None", "HTTPBasic", "Digest", "WSSecurity", "Kerberos", "OAuth" ]
    Default"None"
    AuthUserName
    string
    Max length1024
    AuthPassword
    string (password)
    Max length4096
    SecurityDomain
    string
    Max length1024
    EndPointName
    string
    Max length1024
    PaaConnectionPropertiesPlainidMongodb
    object (PaaConnectionPropertiesPlainidMongodb)
    RemoteServerList
    string Required
    Min length2
    Max length2048
    Database
    string Required
    Max length1024
    Username
    string
    Max length1024
    Password
    string (password)
    Max length1024
    adapter
    string

    The API ignores this value. It sets the adapter from translator.type.

    status
    string

    The API ignores this value. A new Source has the status ACTIVE.

    Responses
    201

    Source Created

    Headers
    x-request-id
    string
    The ID of the request. Give it to PlainID Support when you report a problem.
    Source Created Successfully
    {
      "data": {
        "sourceId": "PIPS4BRPBO81AVPC",
        "paaGroupId": "paa1",
        "adapter": "ws",
        "name": "mockrest2",
        "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": "mockrest2",
            "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": "https://api.your-company.com/endpoint",
              "Password": null,
              "SecurityType": "None"
            }
          }
        ]
      }
    }
    Expand All
    object
    data
    object (PaaSource)
    sourceId
    string

    The Source ID.

    Pattern^PIPS[0-9A-Z]{11,13}$
    ExamplePIPS4BRPBO81AVPC
    paaGroupId
    string

    The PAA Group ID.

    Examplepaa1
    adapter
    string

    The adapter (connection type) of the Source, for example jdbc or ws. The API sets it from translator.type (see PaaSourceTranslator).

    name
    string

    The Source name. It is unique in the PAA Group.

    status
    string

    The status of the Source. The API sets it; it ignores this value in requests. A Source that you create or update with the API has the status ACTIVE.

    Valid values[ "ACTIVE", "SUSPENDED", "FAILED" ]
    description
    string

    The Source description.

    properties
    object (PaaSourceProperties)

    Source-level connection properties. The keys depend on the adapter of the Source, and the adapter depends on translator.type (see PaaSourceTranslator). The values are strings, numbers or booleans. Keys that are specific to one PAA go in paasProperties[].properties.

    AnyOf
    PaaSourcePropertiesJdbc
    object (PaaSourcePropertiesJdbc)
    DriverClassName
    string
    Min length2
    Max length1024
    ConnectionInitSqls
    string
    Max length1024
    ConnectionProperties
    string
    Max length1024
    DefaultReadOnly
    boolean
    InitialSize
    number
    Default2
    DefaultSchema
    string
    Max length1024
    MaxTotal
    number
    MaxIdle
    number
    Default10
    MaxConnLifetimeMillis
    number
    MaxOpenPreparedStatements
    number
    Default100
    MinIdle
    number
    Default5
    PoolPreparedStatements
    boolean
    ValidationQuery
    string
    Max length1024
    Default"SELECT 1"
    IsTransactional
    boolean
    Defaultfalse
    SocketProcessIdPort
    string
    Default"0"
    SocketProcessIdMaxPorts
    number
    Default10
    EnableStatistics
    boolean
    Defaultfalse
    DefaultTimeout
    number
    Default300
    TransactionStatusManagerEnable
    boolean
    Defaultfalse
    TxReaperTimeout
    number
    Default120000
    PaaSourcePropertiesLdap
    object (PaaSourcePropertiesLdap)
    LdapContextFactory
    string
    Max length1024
    LdapTxnTimeoutInMillis
    number
    PaaSourcePropertiesMongodb
    object (PaaSourcePropertiesMongodb)
    AuthDatabase
    string
    Max length2048
    SecurityType
    string
    Valid values[ "None", "SCRAM_SHA_1", "SCRAM_SHA_256", "MONGODB_CR", "Kerberos", "X509" ]
    Default"SCRAM_SHA_1"
    Ssl
    boolean
    Defaultfalse
    PaaSourcePropertiesSalesforce
    object (PaaSourcePropertiesSalesforce)
    ConfigProperties
    string
    Max length4096
    ConnectTimeout
    number
    RequestTimeout
    number
    PaaSourcePropertiesWs
    object (PaaSourcePropertiesWs)
    ConfigFile
    string
    Max length1024
    ConfigName
    string
    Max length1024
    AuthConf
    string
    Max length1024
    ServiceName
    string
    Max length1024
    NamespaceUri
    string
    Max length1024
    RequestTimeout
    number
    ConnectTimeout
    number
    Wsdl
    string
    Max length1024
    PaaSourcePropertiesPlainidMongodb
    object (PaaSourcePropertiesPlainidMongodb)
    AuthDatabase
    string
    Max length2048
    SecurityType
    string
    Valid values[ "None", "SCRAM_SHA_1", "SCRAM_SHA_256", "MONGODB_CR", "Kerberos", "X509" ]
    Default"SCRAM_SHA_1"
    Ssl
    boolean
    Defaultfalse
    translator
    object (PaaSourceTranslator)

    The Teiid translator of the Source. type selects the data source type and the adapter (the connection type) of the Source. The adapter sets the keys of properties and of paasProperties[].properties:

    typeData sourceAdapter
    jdbc-simpleSimple JDBCjdbc
    mysqlMySQLjdbc
    postgresqlPostgreSQLjdbc
    sqlserverMicrosoft SQL Serverjdbc
    oracleOraclejdbc
    db2IBM DB2jdbc
    sybaseSybasejdbc
    ldapLDAPldap
    mongodbMongoDBmongodb
    plainid-mongodbMongoDB (new)plainid-mongodb
    salesforce-41Salesforce (API 41.0)salesforce
    odata4OData v4.0ws
    plainid-restRESTws
    plainid-scimSCIMws
    plainid-azureAzure Active Directoryws
    type
    string

    The translator type. The API compares it without case sensitivity. An unknown value gives 404.

    Valid values[ "jdbc-simple", "mysql", "postgresql", "sqlserver", "oracle", "db2", "sybase", "ldap", "mongodb", "plainid-mongodb", "salesforce-41", "odata4", "plainid-rest", "plainid-scim", "plainid-azure" ]
    Exampleplainid-rest
    name
    string

    The name of the translator instance. When name is empty or omitted, the API uses the value of type. When you also send properties, the API makes a unique name in the form <type>-<3 letters>, for example plainid-rest-iRo.

    Exampleplainid-rest-iRo
    properties
    object

    Translator override properties (Teiid translator settings), for example supportsfilter. All values are strings.

    Example{ "supportsfilter": "true" }
    property*
    string additionalProperties
    models
    Array of object (PaaSourceModel)
    object
    type
    string

    The model type. The models of a Source are PHYSICAL.

    Valid values[ "PHYSICAL", "VIRTUAL" ]
    modelId
    string

    The model ID.

    Pattern^PIPM[0-9A-Z]{11,13}$
    ExamplePIPMM4BRPBO9U88OW
    paaGroupId
    string

    The PAA Group ID.

    visible
    boolean

    When false, clients cannot query the model directly. Views can still use it.

    name
    string

    The model name (the schema name in the PAA).

    description
    string

    The model description.

    sourceIds
    Array of string

    The ID of the Source of the model.

    string
    properties
    object

    Model properties. The values are strings, numbers or booleans.

    metadata
    Array of object (PaaModelMetadata)

    The model definition, usually one DDL item with the CREATE FOREIGN TABLE statements.

    object
    type
    string

    The Teiid metadata type of text. Use DDL (Teiid DDL, for example CREATE FOREIGN TABLE or CREATE VIEW).

    Valid values[ "DDL", "NATIVE", "DDL-FILE", "UDF" ]
    Default"DDL"
    paaId
    string

    The PAA that this metadata applies to. Omit it for metadata that applies to all of the PAAs in the group.

    Pattern^PAA[0-9A-Z]{11,13}$
    text
    string

    The metadata text, for example a Teiid DDL statement.

    Max length1000000
    paasProperties
    Array of object (PaaSourcePaaProperties)

    The connection properties for each PAA of the Source.

    object
    id
    string

    The ID of this set of PAA connection properties.

    ExamplePIMR4BRPBOE7JUGW
    sourceId
    string

    The Source ID.

    paaId
    string

    The PAA ID.

    ExamplePAA3QK1UON1BOXS
    properties
    object (PaaConnectionProperties)

    Connection properties for one PAA. The keys depend on the adapter of the Source, and the adapter depends on translator.type (see PaaSourceTranslator). The values are strings, numbers or booleans.

    Password: responses return null for a stored password, except for a secret reference in the form [NAME] or {{NAME}}, which the API returns as is. On update, send null (or omit the key) to keep the stored password of that PAA.

    AnyOf
    PaaConnectionPropertiesJdbc
    object (PaaConnectionPropertiesJdbc)
    Url
    string (uri)
    Min length2
    Max length1024
    Username
    string
    Max length1024
    Password
    string (password)
    Max length1024
    AuthConf
    string
    Max length1024
    SecurityDomain
    string
    Max length1024
    PaaConnectionPropertiesLdap
    object (PaaConnectionPropertiesLdap)
    LdapUrl
    string (uri)
    Min length2
    LdapAdminUserDN
    string
    Max length1024
    LdapAdminUserPassword
    string (password)
    Max length1024
    LdapAuthType
    string
    Max length1024
    PaaConnectionPropertiesMongodb
    object (PaaConnectionPropertiesMongodb)
    RemoteServerList
    string
    Min length2
    Max length2048
    Database
    string
    Max length1024
    Username
    string
    Max length1024
    Password
    string (password)
    Max length1024
    PaaConnectionPropertiesSalesforce
    object (PaaConnectionPropertiesSalesforce)
    URL
    string (uri)
    Max length4096
    Username
    string
    Max length1024
    Password
    string (password)
    Max length1024
    ProxyURL
    string (uri)
    Max length1024
    ProxyUsername
    string
    Max length1024
    ProxyPassword
    string (password)
    Max length1024
    PaaConnectionPropertiesWs
    object (PaaConnectionPropertiesWs)
    EndPoint
    string
    Max length1024
    SecurityType
    string
    Valid values[ "None", "HTTPBasic", "Digest", "WSSecurity", "Kerberos", "OAuth" ]
    Default"None"
    AuthUserName
    string
    Max length1024
    AuthPassword
    string (password)
    Max length4096
    SecurityDomain
    string
    Max length1024
    EndPointName
    string
    Max length1024
    PaaConnectionPropertiesPlainidMongodb
    object (PaaConnectionPropertiesPlainidMongodb)
    RemoteServerList
    string
    Min length2
    Max length2048
    Database
    string
    Max length1024
    Username
    string
    Max length1024
    Password
    string (password)
    Max length1024
    400

    Bad Request. The request is not valid, or the PAAs could not deploy the change.

    Headers
    x-request-id
    string
    The ID of the request. Give it to PlainID Support when you report a problem.
    Source name already exists
    {
      "errors": [
        {
          "code": "PIP-019",
          "id": "EQ7CMX",
          "status": 400,
          "name": "BaseError",
          "message": "Source with name mockrest already exists"
        }
      ]
    }
    Body sourceId on create
    {
      "errors": [
        {
          "code": "",
          "id": "EQ7CMX",
          "status": 400,
          "name": "BadRequestError",
          "message": "sourceId must be null"
        }
      ]
    }
    PAA not in the PAA Group
    {
      "errors": [
        {
          "code": "",
          "id": "EQ7CMX",
          "status": 400,
          "name": "BaseError",
          "message": "paaId: PAA3QK1UON1BOXS is not belong to paaGroupId: PAG1WMX530NXUKG"
        }
      ]
    }
    Views count mismatch
    {
      "errors": [
        {
          "code": "",
          "id": "EQ7CMX",
          "status": 400,
          "name": "BadRequestError",
          "message": "Metadata count mismatch"
        }
      ]
    }
    Expand All
    object
    errors
    Array of object (Error)
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    401

    The bearer token or the Client ID and Client Secret are missing or not valid.

    Headers
    WWW-Authenticate
    string
    InvalidToken

    Missing or invalid bearer token

    {
      "message": "Invalid or missing authentication token"
    }
    object

    The error returned by AuthZen endpoints, with a single message describing what went wrong. AuthZen endpoints use this format instead of the errors array returned by other Runtime APIs.

    message
    string

    The error message

    ExampleMissing mandatory field: resource
    403

    Forbidden. The access token does not have the permission for this operation on the Environment (or on the Tenant, when envId is -).

    Headers
    x-request-id
    string
    The ID of the request. Give it to PlainID Support when you report a problem.
    Expand All
    object
    errors
    Array of object (Error)
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    404

    Not Found. The Environment, the PAA Group, the Source, the Views or the translator type does not exist.

    Headers
    x-request-id
    string
    The ID of the request. Give it to PlainID Support when you report a problem.
    PAA Group not found
    {
      "errors": [
        {
          "code": "HBC-021",
          "id": "EQ7CMX",
          "status": 404,
          "name": "PaaGroupNotFoundError",
          "message": "PAA Group does not exist"
        }
      ]
    }
    Environment not found
    {
      "errors": [
        {
          "code": "APIV-022",
          "id": "EQ7CMX",
          "status": 404,
          "name": "EnvironmentNotExistError",
          "message": "Environment ID: [not-a-uuid] does not exist"
        }
      ]
    }
    Source not found
    {
      "errors": [
        {
          "code": "",
          "id": "EQ7CMX",
          "status": 404,
          "name": "NotFoundError",
          "message": "source not found"
        }
      ]
    }
    Expand All
    object
    errors
    Array of object (Error)
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    500

    An internal error occurred, or a dependency such as the cache or an Identity Source failed while processing the request.

    CacheUnavailable

    Cache unavailable

    {
      "message": "Unable to connect to Redis cache service"
    }
    IdentitySourceUnavailable

    Identity Source unavailable

    {
      "message": "PIP unreachable"
    }
    InternalError

    Internal error

    {
      "message": "Internal error while evaluating the request"
    }
    object

    The error returned by AuthZen endpoints, with a single message describing what went wrong. AuthZen endpoints use this format instead of the errors array returned by other Runtime APIs.

    message
    string

    The error message

    ExampleMissing mandatory field: resource

    © 2024 PlainID LTD. All rights reserved.