Import Postman Collection Data
POST/v1/projects/{projectId}/import-postman-collectionApidog supports importing data in the Postman Collection v2 format.
Request
The JSON object defined as a string.
Objects containing advanced options and their values for the importing process.
The ID of the target folder for matching APIs. If not specified, the target folder will be the Root folder.
When importing APIs, specify how to handle APIs that matches the existing ones based on the combination of HTTP method and Path. It determines whether to override, automatically merge changes, skip changes and retain the existing API, or create a new one.
Specify how to handle matching Request Definitions within an API. It determines whether to override the existing Request Definition, skip changes and retain the existing one, or create a new Request Definition.
Request Definitions are only matched with Endpoint case when using the same name as an existing one within the same API.
During the import process of an existing API Endpoint, indicate whether to update the catalog ID of the API. If you want to change the catalog ID along with the imported API Endpoint, set this option to true.
{
"input": "string",
"options": {
"targetEndpointFolderId": 0,
"endpointOverwriteBehavior": "OVERWRITE_EXISTING",
"endpointCaseOverwriteBehavior": "OVERWRITE_EXISTING",
"updateFolderOfChangedEndpoint": false
}
}Request samples
Responses
{
"data": {
"counters": {
"endpointCreated": 10,
"endpointUpdated": 0,
"endpointFailed": 0,
"endpointIgnored": 0,
"endpointFolderCreated": 0,
"endpointFolderUpdated": 0,
"endpointFolderFailed": 0,
"endpointFolderIgnored": 0,
"endpointCaseCreated": 0,
"endpointCaseUpdated": 0,
"endpointCaseFailed": 0,
"endpointCaseIgnored": 0
}
}
}