Get an integration's port-app-config schema
GET/v1/integration/:integration_type/port-app-config/schema
This route allows you to get the port-app-config JSON schema for a specific integration type.
The schema describes the structure and available configuration options for the integration's port-app-config file, which controls how data is synced to your software catalog.
To learn more about integrations and the port-app-config, check out the documentation.
Permission requirements
To use this endpoint, you must have a moderator or admin role in your Port organization.
To learn more about the different roles and permissions, please refer to the documentation.
Request
Parameters (JSON)
{
"parameters": [
{
"schema": {
"type": "string"
},
"in": "query",
"name": "version",
"required": false,
"description": "The specific version of the integration definition to retrieve. Omit to get the latest version."
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "integration_type",
"required": true,
"description": "The type identifier of the integration (e.g. \"github\", \"jira\")."
}
]
}Request body schema (JSON)
{
"title": "Body"
}Responses
- 200
- 400
- 404
- 500
Default Response
Default Response
Default Response
Default Response
Responses (JSON)
{
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"definition": {
"type": "object",
"properties": {},
"additionalProperties": false,
"description": "The JSON schema definition for the integration's port-app-config, describing its structure and available configuration options."
}
},
"required": [
"ok",
"definition"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok",
"error"
],
"additionalProperties": false
}
}
}
},
"404": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok",
"error"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok",
"error"
],
"additionalProperties": false
}
}
}
}
}
}