@allthingsapi/ata-cli
Advanced tools
A professional command-line interface (CLI) for API testing, validation, and management. Enables developers to validate OpenAPI specifications, lint API designs, and manage API workflows directly from the terminal with an efficient, developer-friendly exp
A professional command-line interface (CLI) for API testing, validation, and management. Enables developers to validate OpenAPI specifications, lint API designs, and manage API workflows directly from the terminal with an efficient, developer-friendly experience.
npm install -g @allthingsapi/ata-cli
ATA CLI brings powerful, modern API management to your terminal:
ata login).ata whoami).ata logout).ata update).Note: You must be logged in (
ata login) before using any API commands.
ata login
Log in to your ATA account and save your session securely.
ata whoami
Display the currently logged-in user's name and email.
ata api list --team <TEAM_ID> --project <PROJECT_ID>
List all APIs for a specific team and project, including their versions, creator, description, and type.
| Option | Description | Required |
|---|---|---|
--team <TEAM_ID> | The Team ID to filter APIs | Yes |
--project <PROJECT_ID> | The Project ID to filter APIs | Yes |
ata api list --team 6800dfb0d0f8ec7048505892 --project 6800dfb250a4f6540b38913b
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Name: Customer Management API
โ Description: -
โ Application Type: API_APPLICATION
โ Created By: Shoaib Mehedi
โ Versions:
โ โข 1.0 (ub3vc171z): 68275ec4094dd3ec1b66cc85 [DRAFT]
โ โข 2.0 (wzuwzztw8): 6828e0577e417388e07af6f2 [DRAFT]
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
--team or --project is missing, the CLI will show an error and exit.ata login) before using API commands.Execute API tests and collections with comprehensive reporting and environment support. Run entire collections or individual requests with professional test result summaries similar to Postman.
# Run an entire collection with all tests
ata run --collection 68078d82e83b814cd6fbec6b
# Run a collection with environment variables
ata run --collection 68078d82e83b814cd6fbec6b --env 6800dfbcd9ba2022c515beaf
# Run a collection and save results to file
ata run --collection 68078d82e83b814cd6fbec6b --report results.json
# Execute a single request
ata execute 68a2ca5acae0c4a58821a5eb
# Execute a request with environment
ata execute 68a2ca5acae0c4a58821a5eb --env 6800dfbcd9ba2022c515beaf
ata collection requests <COLLECTION_ID>
Display all requests in a collection with detailed information including request methods, URLs, test information, and timestamps. Perfect for understanding collection contents before execution.
ata run --collection <COLLECTION_ID> [--env <ENV_ID>] [--genv <GLOBAL_ID>] [--report <report.json>]
ata run --collection <COLLECTION_ID> --env <ENV_ID> --genv <GLOBAL_ID> -r <report.json>
Execute a specific request from any collection with optional environment and global variable support. Perfect for debugging individual API calls or quick testing.
ata execute <REQUEST_ID> [--env <ENV_ID>] [--genv <GLOBAL_ID>]
For ata run:
| Option | Description | Required |
|---|---|---|
--collection <COLLECTION_ID> | The collection ID to run | Yes |
--env <ENV_ID> | (Optional) Environment ID to use for execution | No |
--genv <GLOBAL_ID> | (Optional) Global ID to use for execution | No |
--report <report.json> | Save the run report to a local file (JSON) | No |
-r <report.json> | Shorthand for --report | No |
For ata execute:
| Option | Description | Required |
|---|---|---|
<REQUEST_ID> | The request ID to execute | Yes |
--env <ENV_ID> | (Optional) Environment ID to use for execution | No |
--genv <GLOBAL_ID> | (Optional) Global ID to use for execution | No |
# List all requests in a collection
ata collection requests 68a2ca5acae0c4a58821a5e9
# Run a collection with environment and global context
ata run --collection 68078d82e83b814cd6fbec6b --env 6800dfbcd9ba2022c515beaf --genv 6800dfbcd9ba2022c515beaf --report results.json
# Run a collection without environment/global context
ata run --collection 68078d82e83b814cd6fbec6b
# Execute a single request
ata execute 68a2ca5acae0c4a58821a5eb
# Execute with environment variables
ata execute 68a2ca5acae0c4a58821a5eb --env 6800dfbcd9ba2022c515beaf
Note:
--envand--genvare mapped internally to the API'senvIdandglobalIdparameters for flexible environment and global context support. They are optional; omit them to use default API behavior.
--report or -r is provided, a machine-readable JSON file is saved with the full run details.Found 6 requests in collection.
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Request: New Request [682b01c3f80b20dd07da3804]
Status: โ PASSED
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Request: update [68078d82e83b814cd6fbec6c]
โ Check if request method is PUT
โ Verify status code is 422 for invalid PUT request: Expected 200 to equal 422
โ Check response body is empty: Expected [object Object] to be empty
โ Verify Content-Type header in response
โ Response time is less than 300ms: Expected 469 to be below 300
โ Verify status code for DELETE request returns 200
โ Verify response body is empty for DELETE request: Expected [object Object] to be empty
โ Verify Content-Type header in response: ata.expect(...).to.contain is not a function
โ Verify response time is less than 300ms for DELETE request: Expected 469 to be below 300
โ Verify DELETE request does not return a body: ata.response.body is not a function
Status: โ FAILED
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Request: patch [68078d82e83b814cd6fbec6d]
โ Verify request method is PATCH
โ Verify response status code is 200
โ Verify Content-Type header is present
โ Verify response time is less than 300ms
Status: โ PASSED
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Request: delete [68078d82e83b814cd6fbec6e]
Status: โ PASSED
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Request: getlist [68078d82e83b814cd6fbec6f]
Status: โ PASSED
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Request: add [68078d82e83b814cd6fbec70]
โ Request method should be POST
โ Validate response status code for invalid data: Expected 201 to equal 422
โ Check response body is empty: Expected [object Object] to be empty
โ Ensure Content-Type header is present in response
โ Response time is less than 300ms: Expected 760 to be below 300
Status: โ FAILED
=============================================
Collection Run Summary
=============================================
Total Requests: 6
Passed: 4
Failed: 2
4 PASSED, 2 FAILED
=============================================
Report saved to results.json
{
"collectionId": "68078d82e83b814cd6fbec6b",
"runAt": "2025-05-18T20:52:41.099Z",
"summary": {
"total": 5,
"passed": 0,
"failed": 5
},
"results": [
{
"name": "update",
"id": "68078d82e83b814cd6fbec6c",
"status": "FAILED",
"testResults": [
{ "name": "Check if request method is PUT", "success": false, "error": "ata.request.method is not a function" }
],
"error": "Test Failures: Check if request method is PUT: ata.request.method is not a function"
},
...
]
}
ata run command provides a professional, Postman-like summary and reporting experienceโideal for automated testing, CI/CD, and developer workflows.Create comprehensive test suites for your projects with support for multiple testing frameworks and test types. Test suites enable you to organize and automate API testing across multiple collections.
Key Features:
ata test create-test-suite \
--team <TEAM_ID> \
--project <PROJECT_ID> \
--framework <FRAMEWORK> \
--type <TEST_TYPE> \
--itemName <SUITE_NAME> \
--apiCollections <COLLECTION_IDS> \
--testSuiteType <SUITE_TYPE> \
--generateCode <YES|NO>
| Option | Description | Required | Example Values |
|---|---|---|---|
--team | Team ID for the test suite | Yes | 690b009797745f554ec67540 |
--project | Project ID where the test suite will be created | Yes | 690b00ea1ea8bdc5de00020a |
--framework | Testing framework to use | Yes | ATA, CHAI, JAVA, PYTHON |
--type | Test suite access level | Yes | COMPANY, TEAM, PRIVATE |
--itemName | Name for the test suite | Yes | "User Authentication Tests" |
--apiCollections | Comma-separated list of API collection IDs to include in suite (no spaces or use quotes) | Yes | "id1,id2,id3" or id1,id2,id3 |
--testSuiteType | Type of testing to perform | Yes | ROBUSTNESS, SECURITY_TEST, PERFORMANCE_TEST |
--generateCode | Enable automatic assertion generation | No | YES (default), NO |
# Create a security test suite with multiple collections
ata test create-test-suite \
--team 690b009797745f554ec67540 \
--project 690b00ea1ea8bdc5de00020a \
--framework ATA \
--type TEAM \
--itemName "Security Test Suite" \
--apiCollections "692fdf45cff32bf194f6f607,692fcc5b0ed97fc4f7ad987c,692fbbd5fb696d7b6cefd0e1" \
--testSuiteType SECURITY_TEST \
--generateCode YES
# Create a performance test suite for a single collection
ata test create-test-suite \
--team 690b009797745f554ec67540 \
--project 690b00ea1ea8bdc5de00020a \
--framework PYTHON \
--type PRIVATE \
--itemName "API Performance Tests" \
--apiCollections "692fdf45cff32bf194f6f607" \
--testSuiteType PERFORMANCE_TEST
Creating test suite...
โ Test suite created successfully!
==============================================
Test Suite Details
==============================================
Test Suite ID: 693abc123def456789012345
Name: Security Test Suite
Framework: ATA
Type: SECURITY_TEST
Collections: 3 collection(s)
Before creating test suites, ensure you have:
ata login to authenticateThe command requires the following environment variables in your .env.prod or .env file:
# Collection API endpoint
COLLECTION_API_URL=https://dev.api.collection-server.ata.dev
# Collection API key (required for authorization)
ATA_API_KEY=your-actual-collection-api-key
# or
API_KEY_COLLECTION=your-actual-collection-api-key
ata loginATA_API_KEY or API_KEY_COLLECTION is set to a valid value (not a placeholder)~/.ata-cli-config.json)${COLLECTION_API_URL}/api-test-suitesaccesstoken, x-api-key, content-type, acceptMultiple Collections: When specifying multiple collection IDs with spaces, wrap the entire list in quotes:
--apiCollections "692fdf45cff32bf194f6f607, 692fcc5b0ed97fc4f7ad987c"
Or without spaces (no quotes needed):
--apiCollections 692fdf45cff32bf194f6f607,692fcc5b0ed97fc4f7ad987c
Test Suite Naming: Use descriptive names that clearly indicate the suite's purpose:
--itemName "User Authentication & Authorization Tests"
Framework Selection: Choose the framework that matches your existing testing infrastructure:
ATA for native AllThingsAPI integrationCHAI, JAVA, or PYTHON if you have existing test frameworksAccess Control: Consider who needs access when setting the type:
TEAM: Best for collaborative testing within a specific teamCOMPANY: Use for organization-wide test suitesPRIVATE: Ideal for experimental or personal test developmentAutomatically generate test cases for all requests in a test suite using AI-powered test generation. This command initiates bulk test case generation for an entire test suite.
ata test generate-testcase-all \
--team <TEAM_ID> \
--project <PROJECT_ID> \
--testSuiteId <TEST_SUITE_ID> \
--type <TEST_TYPE> \
--module <MODULE>
| Option | Description | Required | Example Values |
|---|---|---|---|
--team | Team ID | Yes | 690b009797745f554ec67540 |
--project | Project ID | Yes | 690b00ea1ea8bdc5de00020a |
--testSuiteId | Test Suite ID to generate tests for | Yes | 693abc123def456789012345 |
--type | Test type | Yes | robustness, security, performance |
--module | Test module | Yes | robustness, security_test, performance_test |
ata test generate-testcase-all \
--team 690b009797745f554ec67540 \
--project 690b00ea1ea8bdc5de00020a \
--testSuiteId 693abc123def456789012345 \
--type security \
--module security_test
โ Cloning version package for application version...
โ Bulk generation scheduled!
==============================================
Generation Details
==============================================
Status: PROCESSING
message: Test case generation has been queued
collections: 3
Generate or retrieve test cases for a specific API request. This command allows fine-grained control over test generation for individual requests.
ata test generate-testcase-request \
--team <TEAM_ID> \
--project <PROJECT_ID> \
--request <REQUEST_ID> \
--type <TEST_TYPE> \
--testSuiteId <TEST_SUITE_ID> \
--apiCollection <API_COLLECTION_ID> \
--force <true|false>
| Option | Description | Required | Default | Example Values |
|---|---|---|---|---|
--team | Team ID | Yes | - | 690b009797745f554ec67540 |
--project | Project ID | Yes | - | 690b00ea1ea8bdc5de00020a |
--request | Specific request ID to generate tests for | Yes | - | 692fdf45cff32bf194f6f607 |
--type | Test type | Yes | - | robustness, security, performance |
--testSuiteId | Test Suite ID | Yes | - | 693abc123def456789012345 |
--apiCollection | API Collection ID | Yes | - | 692fbbd5fb696d7b6cefd0e1 |
--force | Force regeneration if tests exist | No | false | true, false |
# Generate test cases for a specific request
ata test generate-testcase-request \
--team 690b009797745f554ec67540 \
--project 690b00ea1ea8bdc5de00020a \
--request 692fdf45cff32bf194f6f607 \
--type security \
--testSuiteId 693abc123def456789012345 \
--apiCollection 692fbbd5fb696d7b6cefd0e1
# Force regeneration of existing test cases
ata test generate-testcase-request \
--team 690b009797745f554ec67540 \
--project 690b00ea1ea8bdc5de00020a \
--request 692fdf45cff32bf194f6f607 \
--type robustness \
--testSuiteId 693abc123def456789012345 \
--apiCollection 692fbbd5fb696d7b6cefd0e1 \
--force true
โ Generation by request ID............
โ Test Case Generation Started!
==============================================
Generation Details
==============================================
Total Count: 12
Status: COMPLETED
--force true to regenerate test cases even if they already exist--force, the command will return existing test cases if availableExecute all test cases for a specific request with optional environment and dataset support.
ata test run-all-testcase \
--testSuiteId <TEST_SUITE_ID> \
--request <REQUEST_ID> \
--env <ENVIRONMENT_ID> \
--dataSet <DATASET_ID>
| Option | Description | Required | Example Values |
|---|---|---|---|
--testSuiteId | Test Suite ID containing the test cases | Yes | 693abc123def456789012345 |
--request | Request ID to execute test cases for | Yes | 692fdf45cff32bf194f6f607 |
--env | Environment ID for test execution | No | 6800dfbcd9ba2022c515beaf |
--dataSet | Dataset ID for data-driven testing | No | dataset123456789 |
# Run all test cases for a request
ata test run-all-testcase \
--testSuiteId 693abc123def456789012345 \
--request 692fdf45cff32bf194f6f607
# Run with specific environment
ata test run-all-testcase \
--testSuiteId 693abc123def456789012345 \
--request 692fdf45cff32bf194f6f607 \
--env 6800dfbcd9ba2022c515beaf
# Run with environment and dataset
ata test run-all-testcase \
--testSuiteId 693abc123def456789012345 \
--request 692fdf45cff32bf194f6f607 \
--env 6800dfbcd9ba2022c515beaf \
--dataSet dataset123456789
โ Run All Test Cases......
โ Generation process has been initiated!
==============================================
Generation Details
==============================================
Message: All test cases execution started successfully
Execute UI automation tests using Playwright for end-to-end testing. Supports multiple test levels from individual test cases to entire applications.
ata test run-ui-automation \
--type <TEST_TYPE> \
--application <APPLICATION_ID> \
[type-specific options] \
[execution options]
| Option | Description | Required | Default | Example Values |
|---|---|---|---|---|
--type | Test execution level | Yes | - | TEST_CASE, TEST_SCENARIO, TEST_SUITE, APPLICATION |
--application | Application ID | Yes | - | 901stu234vwx |
--testCase | Test Case ID (for TEST_CASE type) | Conditional | - | 123abc456def |
--testScenario | Test Scenario ID (for TEST_SCENARIO/TEST_CASE) | Conditional | - | 789ghi012jkl |
--testSuite | Test Suite ID (for TEST_SUITE/TEST_SCENARIO/TEST_CASE) | Conditional | - | 345mno678pqr |
--dataSet | Dataset ID for data-driven tests | No | - | dataset123456 |
--testContent | Custom test content (for TEST_CASE) | No | - | - |
--headed | Run with visible browser UI | No | false | - |
--poll-interval | Report polling interval in seconds | No | 5 | 3, 10 |
--timeout | Max wait time in minutes | No | 30 | 15, 60 |
TEST_CASE: Requires --testCase, --testScenario, --testSuite, --application
TEST_SCENARIO: Requires --testScenario, --testSuite, --application
TEST_SUITE: Requires --testSuite, --application
APPLICATION: Requires only --application
# Run a specific test case (headless)
ata test run-ui-automation \
--type TEST_CASE \
--testCase 123abc456def \
--testScenario 789ghi012jkl \
--testSuite 345mno678pqr \
--application 901stu234vwx
# Run test scenario with visible browser
ata test run-ui-automation \
--type TEST_SCENARIO \
--testScenario 789ghi012jkl \
--testSuite 345mno678pqr \
--application 901stu234vwx \
--headed
# Run entire test suite with custom polling
ata test run-ui-automation \
--type TEST_SUITE \
--testSuite 345mno678pqr \
--application 901stu234vwx \
--poll-interval 10 \
--timeout 60
# Run all application tests with dataset
ata test run-ui-automation \
--type APPLICATION \
--application 901stu234vwx \
--dataSet dataset123456 \
--headed
โ Starting TEST_CASE UI automation test...
โ Test execution started successfully!
==============================================
Test Execution Details
==============================================
Report ID: 693def456abc789012345678
Test Type: TEST_CASE
Test Case: 123abc456def
Test Scenario: 789ghi012jkl
Test Suite: 345mno678pqr
Application: 901stu234vwx
Mode: Headless
Polling for test results...
โ Polling... (12) - Status: RUNNING - Progress: 60%
โ Test execution completed!
Report URL: https://dev.api.express-server.ata.dev/reports/693def456abc789012345678
โ All tests passed successfully!
http://localhost:10534)
# Check if agent is running
curl http://localhost:10534/agent/knockknock
ata loginThe command uses the following environment variables:
# ATA Agent endpoint for UI automation
AGENT_API_URL=http://localhost:10534
# Express server for report polling
EXPRESS_URL=https://dev.api.express-server.ata.dev
--headed): Browser UI visible, useful for debugging and developmentThe command provides proper exit codes for automation:
0: All tests passed successfully1: Test execution failed, timeout, or connection errorPerfect for integration into CI/CD pipelines with automatic failure detection.
Execute workflow tests for both API Chained Testing and E2E UI Automation Testing. Supports real-time monitoring of workflow execution with comprehensive node status reporting.
ata test run-workflow --workflowId <WORKFLOW_ID>
| Option | Description | Required | Example Values |
|---|---|---|---|
--workflowId | Workflow ID to execute | Yes | 68cd3243a7e3cf7b6b0e5f1e |
# Run a workflow test
ata test run-workflow --workflowId 68cd3243a7e3cf7b6b0e5f1e
โ Fetching workflow details...
โ Workflow details fetched successfully
โ Fetching workflow versions...
โ Workflow versions fetched successfully
==============================================
Workflow Execution Details
==============================================
Workflow ID: 68cd3243a7e3cf7b6b0e5f1e
Workflow Version: 68cd3244a7e3cf
==============================================
โ Starting workflow execution...
โ Test case generation has been initiated successfully!
Execution ID: cc833cf6-665b-49b9-92ff-ac0086921d06
Execution Status: COMPLETED
==============================================
Workflow Nodes Summary
==============================================
โโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโ
โ Type โ Status โ
โโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโค
โ start โ COMPLETED โ
โ condition โ COMPLETED โ
โ activity โ COMPLETED โ
โโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโ
API Chained Testing
E2E UI Automation Testing
ata loginThe command uses the following environment variables:
# Workflow server endpoint
WORKFLOW_API_URL=https://dev.workflow-server.ata.dev
| Type | Description |
|---|---|
| start | Initial entry point of the workflow |
| condition | Conditional logic nodes for branching |
| activity | Action nodes (API calls, UI interactions) |
ata login againThe command provides proper exit codes for automation:
0: Workflow executed successfully1: Workflow execution failed or connection errorPerfect for integration into CI/CD pipelines for automated workflow testing.
Validate and lint your OpenAPI specifications against standard and custom policy rules using the Spectral CLI. Supports both remote API specs and local OpenAPI files in JSON and YAML formats.
# Lint a remote API specification
ata api lint --package <PACKAGE_ID> --policy <POLICY_ID|default>
# Lint a local OpenAPI file
ata api lint --file <FILE_PATH> --policy <POLICY_ID|default>
| Option | Description | Required |
|---|---|---|
--package <PACKAGE_ID> | Package ID containing the OpenAPI spec to lint | Yes (if --file not provided) |
--file <FILE_PATH> | Path to local OpenAPI file (.json, .yml, .yaml) | Yes (if --package not provided) |
--policy <POLICY_ID> | Policy ID to validate against (use 'default' for standard OpenAPI rules) | No |
# Validate a remote API spec against standard OpenAPI rules
ata api lint --package 68275ec4094dd3ec1b66cc85 --policy default
# Validate a remote API spec against a specific custom policy
ata api lint --package 68275ec4094dd3ec1b66cc85 --policy 6800dfbffee72cc9c148b38f
# Validate a local JSON file against standard OpenAPI rules
ata api lint --file ./specs/my-api.json --policy default
# Validate a local YAML file against a specific custom policy
ata api lint --file ./specs/petstore.yaml --policy 6800dfbffee72cc9c148b38f
The CLI package includes sample OpenAPI files in the test-specs directory that you can use for testing and reference:
test-specs/sample-openapi.json - A valid OpenAPI specificationtest-specs/flawed-openapi.json - An OpenAPI specification with intentional issues for testing linting functionalitytest-specs/.spectral.yaml - A sample Spectral configuration fileYou can use these files to experiment with the linting functionality:
# Test linting with the included sample files
ata api lint --file ./test-specs/flawed-openapi.json --policy default
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ OpenAPI Specification Lint Results โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Package ID: 68275ec4094dd3ec1b66cc85 โ
โ Policy: 6800dfbffee72cc9c148b38f โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Summary โ
โ โข Total Issues: 1 โ
โ โข Errors: 1 โ
โ โข Warnings: 0 โ
โ โข Info: 0 โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Errors โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โโ [6800dfbffee72cc9c148b38f-rule] API must โ
โdefine security schemes โ
โ components โ
โ at line 130 โ
โ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ โ Failed: API specification has errors โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Dual Validation Modes:
Policy-Specific Rules: Different policies validate different aspects of the API:
Professional Output:
Advanced Implementation:
--package or --file must be provided (but not both)DEBUG=1)Export the OpenAPI specification for a version package in JSON or YAML format.
ata api get --package <PACKAGE_ID> --output <openapi.json|openapi.yaml|openapi.yml>
| Option | Description | Required |
|---|---|---|
--package <PACKAGE_ID> | The version package ID to export | Yes |
--output <FILE> | Output file name (extension determines format) | No |
.json (default): OpenAPI JSON.yaml or .yml: OpenAPI YAMLata api get --package 68275ec4094dd3ec1b66cc85 --output openapi.json # JSON
ata api get --package 68275ec4094dd3ec1b66cc85 --output openapi.yaml # YAML
ata api get --package 68275ec4094dd3ec1b66cc85 --output openapi.yml # YAML
If --output is not specified, the CLI will default to openapi-<PACKAGE_ID>.json.
--package is missing, the CLI will show an error and exit.ata login) before using api get.Update an OpenAPI specification for a package by uploading content from a local file.
ata api update --package <PACKAGE_ID> --file <FILE_PATH>
| Option | Description | Required |
|---|---|---|
--package <PACKAGE_ID> | Package ID to update | Yes |
--file <FILE_PATH> | Path to OpenAPI spec file | Yes |
ata api update --package abc123 --file ./openapi.json
.json, .yml, .yaml)You must be logged in (ata login) before using this command.
Create and manage environments for API testing with team and project scoping. Environments store variables and configurations that can be used across collections and requests.
ata env create --name <NAME> --project <PROJECT_ID> --team <TEAM_ID> [options]
Create a new environment with specified configurations.
| Option | Description | Required | Default |
|---|---|---|---|
--name <NAME> | Environment name | Yes | - |
--project <PROJECT_ID> | Project ID | Yes | - |
--team <TEAM_ID> | Team ID | Yes | - |
--description <TEXT> | Environment description | No | - |
--type <TYPE> | Environment type | No | TEAM |
--for <FOR> | Environment for | No | API_LAB |
--global | Make environment global | No | false |
--locked | Lock the environment | No | false |
--no-public | Make environment private | No | public |
# Create a basic environment
ata env create --name "Development" --project 68c97f9b251a3b05ffa18608 --team 68c97f9948483ccaf657c0fe
# Create a global environment with description
ata env create --name "Production" --project 68c97f9b251a3b05ffa18608 --team 68c97f9948483ccaf657c0fe --description "Production environment variables" --global
# Create a locked, private environment
ata env create --name "Staging" --project 68c97f9b251a3b05ffa18608 --team 68c97f9948483ccaf657c0fe --locked --no-public
ata env list --project <PROJECT_ID> [options]
List environments for a specific project with optional filtering.
| Option | Description | Required |
|---|---|---|
--project <PROJECT_ID> | Project ID to list environments for | Yes |
--team <TEAM_ID> | Filter by team ID | No |
--name <SEARCH_NAME> | Search by environment name | No |
--global | Show only global environments | No |
# List all environments for a project
ata env list --project 68c97f9b251a3b05ffa18608
# List environments for a specific project and team
ata env list --project 68c97f9b251a3b05ffa18608 --team 68c97f9948483ccaf657c0fe
# Search for environments by name
ata env list --project 68c97f9b251a3b05ffa18608 --name "dev"
# List only global environments for a project
ata env list --project 68c97f9b251a3b05ffa18608 --global
ata env delete <ENV_ID> [options]
Delete an environment by its ID.
| Option | Description | Required |
|---|---|---|
--force | Skip confirmation prompt | No |
# Delete with confirmation
ata env delete 6829abc123def456789
# Delete without confirmation
ata env delete 6829abc123def456789 --force
ata env get <ENV_ID|DATASET_ID> [options]
Retrieve and display environment variables from an environment or dataset.
| Option | Description | Required | Default |
|---|---|---|---|
--output <FILE> | Export variables to file | No | - |
--format <FORMAT> | Output format (json or env) | No | json |
--show-secrets | Display secret values | No | false |
# Get environment variables (secrets hidden)
ata env get 68cbf3a1608f5fbdf23ff298
# Show all variables including secrets
ata env get 68cbf3a1608f5fbdf23ff298 --show-secrets
# Export to JSON file
ata env get 68cbf3a1608f5fbdf23ff298 --output variables.json
# Export to .env file with secrets
ata env get 68cbf3a1608f5fbdf23ff298 --output .env --format env --show-secrets
# Export for use in application
ata env get 68cbf3a1608f5fbdf23ff298 --output production.env --format env
โ
Environment variables retrieved successfully!
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Dataset: Default DataSet
Dataset ID: 68cbf3a1608f5fbdf23ff298
Default: Yes
Global: No
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Variables:
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Name: base_url
Value: https://api.example.com/
Type: DEFAULT
Active: Yes
Encrypted: No
Name: api_key
Value: ******* (secret)
Type: SECRET
Active: Yes
Encrypted: No
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Total variables: 2
Import collections from various sources including ATA, Postman, and Swagger/OpenAPI specifications. Collections can be imported at team, company, or personal levels with public/private visibility options.
ata collection import --project <PROJECT_ID> --from <SOURCE> [options]
Import a collection from supported formats into your ATA project.
| Option | Description | Values |
|---|---|---|
--project <PROJECT_ID> | Target project ID | Project ID string |
--from <SOURCE> | Import source format | ATA, POSTMAN, SWAGGER |
| Option | Description |
|---|---|
--team <TEAM_ID> | Import to team level |
--company <COMPANY_ID> | Import to company level |
--personal <PERSONAL_ID> | Import to personal level |
| Option | Description | Required For |
|---|---|---|
--file <PATH> | Path to collection file | ATA, Postman, Swagger file |
--url <URL> | Swagger specification URL | Swagger URL import only |
--public | Make collection public (default: false) | Optional |
# Import ATA collection to team level
ata collection import --project 688c7a1b03cdbd47222fc9e3 --team 688c63fe5e9ad48f3217e75f --from ATA --file collection.json
# Import ATA collection to company level as public
ata collection import --project 688c7a1b03cdbd47222fc9e3 --company abc123 --from ATA --file collection.json --public
# Import Postman collection to team
ata collection import --project 688c7a1b03cdbd47222fc9e3 --team 688c63fe5e9ad48f3217e75f --from POSTMAN --file postman-collection.json
# Import Postman collection to personal workspace
ata collection import --project 688c7a1b03cdbd47222fc9e3 --personal user123 --from POSTMAN --file my-tests.json
# Import from Swagger file
ata collection import --project 688c7a1b03cdbd47222fc9e3 --team 688c63fe5e9ad48f3217e75f --from SWAGGER --file openapi.json
# Import from Swagger URL
ata collection import --project 688c7a1b03cdbd47222fc9e3 --team 688c63fe5e9ad48f3217e75f --from SWAGGER --url https://petstore.swagger.io/v2/swagger.json
# Import Swagger to company level as public
ata collection import --project 688c7a1b03cdbd47222fc9e3 --company abc123 --from SWAGGER --url https://api.example.com/swagger.json --public
ata collection import-package <PACKAGE_ID> [options]
Import a collection directly from an application package containing OpenAPI specifications. This command extracts the OpenAPI spec from the package and automatically imports it as a collection.
| Argument | Description |
|---|---|
<PACKAGE_ID> | Application package ID containing OpenAPI spec |
| Option | Description |
|---|---|
--project <PROJECT_ID> | Override project ID from package |
--team <TEAM_ID> | Override team ID or import to specific team |
--company <COMPANY_ID> | Import to company level instead of team |
--personal <PERSONAL_ID> | Import to personal level instead of team |
--public | Make collection public (default: false) |
# Import using package's default team and project
ata collection import-package 68cd3244a7e3cf7b6b0e5f1f
# Override the target project
ata collection import-package 68cd3244a7e3cf7b6b0e5f1f --project 6800dfb250a4f6540b38913b
# Import to company level
ata collection import-package 68cd3244a7e3cf7b6b0e5f1f --company 6848011ff1118197c2bf3dd4
# Import as public collection to personal workspace
ata collection import-package 68cd3244a7e3cf7b6b0e5f1f --personal user123 --public
โ Collection imported successfully to team 688c63fe5e9ad48f3217e75f
Collection ID: 68d123abc456def789012345
ata loginCreate and manage automated API monitors to continuously test your collections on schedules, receive failure notifications, and track performance over time.
ata monitor create --project <PROJECT_ID> --team <TEAM_ID> --name <NAME> --collection <COLLECTION_ID> [options]
Create a new API monitor with scheduling and notification configurations.
| Option | Description |
|---|---|
--project <PROJECT_ID> | Project ID for the monitor |
--team <TEAM_ID> | Team ID for the monitor |
--name <NAME> | Monitor name |
--collection <COLLECTION_ID> | Collection ID to monitor |
| Option | Description | Default |
|---|---|---|
--type <TYPE> | Monitor type (AD_HOC or SCHEDULED) | AD_HOC |
--status <STATUS> | Initial status (DRAFT or ACTIVE) | DRAFT |
--env <ENV_ID> | Environment ID(s) to use (can specify multiple) | - |
--global-env <GLOBAL_ENV_ID> | Global environment ID | - |
| Option | Description | Example |
|---|---|---|
--frequency <FREQUENCY> | Execution frequency (DAYS, WEEKS, MONTHS) | WEEKS |
--day <DAY> | Day of week for weekly execution | MONDAY |
--time <TIME> | Execution time (HH:MM format) | 08:00 |
| Option | Description | Example |
|---|---|---|
--failure-email <EMAILS> | Email addresses for failure notifications (comma-separated) | alert@example.com |
--report-email <EMAILS> | Email addresses for report delivery (comma-separated) | report@example.com |
--retry-option <OPTION> | Retry option on failure | retryAfterInHour |
--retry-interval <INTERVAL> | Retry interval | 1 |
ata monitor create --project 68a6ff1aca191aa0c2e2d338 --team 68903049d0c5b7af278a038a --name "Production API Monitor" --collection 68cd1de4de25bda1a6410aa9
ata monitor create \
--project 68a6ff1aca191aa0c2e2d338 \
--team 68903049d0c5b7af278a038a \
--name "Weekly API Health Check" \
--collection 68cd1de4de25bda1a6410aa9 \
--type SCHEDULED \
--status ACTIVE \
--frequency WEEKS \
--day MONDAY \
--time 08:00 \
--failure-email "alerts@example.com,team@example.com" \
--report-email "reports@example.com" \
--env 68b6882d075f76072ec76117
ata monitor create \
--project 68a6ff1aca191aa0c2e2d338 \
--team 68903049d0c5b7af278a038a \
--name "Multi-Env Monitor" \
--collection 68cd1de4de25bda1a6410aa9 \
--env 68b6882d075f76072ec76117 \
--env 68b6882d075f76072ec76118 \
--global-env 68b6882d075f76072ec76119
ata monitor list --project <PROJECT_ID> [options]
List all monitors for a project with filtering and pagination options.
| Option | Description | Default |
|---|---|---|
--project <PROJECT_ID> | Project ID (required) | - |
--page <PAGE> | Page number | 1 |
--size <SIZE> | Page size | 10 |
--search-name <NAME> | Search by name | - |
--monitor-name <NAME> | Filter by monitor name | - |
--collection-name <NAME> | Filter by collection name | - |
--status <STATUS> | Filter by status (ACTIVE, DRAFT, PAUSED) | - |
--failure-via <VIA> | Filter by failure notification method | - |
--report-via <VIA> | Filter by report delivery method | - |
--created-at <DATE> | Filter by creation date | - |
# List all monitors for a project
ata monitor list --project 68a6ff1aca191aa0c2e2d338
# Filter by status and paginate
ata monitor list --project 68a6ff1aca191aa0c2e2d338 --status ACTIVE --page 2 --size 20
# Search for specific monitors
ata monitor list --project 68a6ff1aca191aa0c2e2d338 --search-name "production"
ata monitor runs <MONITOR_ID>
Get the execution history for a specific monitor, including run status, test results, and performance metrics.
ata monitor runs 68cd1f153ad693e0e260a15d
==============================================
Monitor Run History
==============================================
Monitor ID: 68cd1f153ad693e0e260a15d
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Summary:
Total Runs: 24
โ Successful: 20
โ Failed: 4
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Run #1 [Tag: 1758273305009]
Status: โ SUCCESS
Date: 1/19/2025, 2:15:05 PM
Requests: 10
Tests: 25 total (23 passed, 2 failed)
Duration: 1250ms
Run #2 [Tag: 1758273304008]
Status: โ FAILED
Date: 1/19/2025, 2:00:04 PM
Requests: 10
Tests: 25 total (18 passed, 7 failed)
Duration: 1450ms
Error: Connection timeout
ata monitor run-details <MONITOR_ID> --tag <TAG> [--output <FILE>]
Get a detailed report for a specific monitor run, including individual request results, test outcomes, and performance metrics.
| Option | Description |
|---|---|
--tag <TAG> | Run tag identifier (required) |
--output <FILE> | Save detailed report to JSON file |
# View run details in console
ata monitor run-details 68cd1f153ad693e0e260a15d --tag 1758273305009
# Save detailed report to file
ata monitor run-details 68cd1f153ad693e0e260a15d --tag 1758273305009 --output report.json
==============================================
Monitor Run Detailed Report
==============================================
Monitor ID: 68cd1f153ad693e0e260a15d
Run Tag: 1758273305009
๐ Run Summary:
Status: โ SUCCESS
Executed At: 1/19/2025, 2:15:05 PM
Duration: 1.3s
๐ Request Statistics:
Total Requests: 10
โ Successful: 9
โ Failed: 1
๐งช Test Results:
Total Tests: 25
โ Passed: 23
โ Failed: 2
๐ Test Cases:
โ Check status code is 200
โ Verify response time < 500ms
โ Validate response schema
Error: Expected property 'id' to be present
โ Check content-type header
๐จ Request Details:
Request #1: GET /api/users
Method: GET
URL: https://api.example.com/api/users
Status Code: 200
Response Time: 125ms
Tests:
โ Status code is 200
โ Response time < 500ms
โก Performance Metrics:
Average Response Time: 135ms
Min Response Time: 89ms
Max Response Time: 245ms
P95 Response Time: 210ms
ata team list
List all teams assigned to the current user, including team names, IDs, descriptions, and member counts.
==============================================
Available Teams
==============================================
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Team: Backend Developers [6848011ff1118197c2bf3dd4]
Created: 6/10/2025, 9:55:44 AM
Description: Core development team for API services
Members: 8
Alias: be-dev
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ 3 teams retrieved successfully.
ata team business-apps <TEAM_ID>
Display all business applications associated with a specific team, including detailed information about each application.
| Option | Description | Required |
|---|---|---|
<TEAM_ID> | The Team ID to get business apps for | Yes |
ata team business-apps 6848011ff1118197c2bf3dd4
=======================================================
Business Applications for Team
=======================================================
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Title: Backend Developers [68480147654d33540dea419f]
Created: 6/10/2025, 9:56:23 AM
Description:
Type: PUBLIC
Category: TEAM
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Title: Team Business Application [684801208724f47ae6fcbc73]
Created: 6/10/2025, 9:55:44 AM
Description: Default Project
Type: PUBLIC
Category: TEAM
Robustness Tests: 9
Security Tests: 19
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ 2 business application(s) retrieved successfully.
ata policy list [OPTIONS]
List all governance policies with support for filtering, searching, and pagination. Policies help enforce API design standards and best practices across your organization.
| Option | Description | Default |
|---|---|---|
--page <NUMBER> | Page number for pagination | 1 |
--size <NUMBER> | Number of policies per page | 10 |
--search <TEXT> | Search term to filter policies | - |
--type <TYPE> | Filter by policy type | - |
--status <STATUS> | Filter by status (ACTIVE, DRAFT, DISABLED, ARCHIVED) | - |
# List all policies with default pagination
ata policy list
# Search for specific policies
ata policy list --search "OWASP"
# Filter by status and use custom pagination
ata policy list --status ACTIVE --page 2 --size 5
# Combine search and filters
ata policy list --search "security" --type API --status DRAFT
==============================================
Governance Policies
==============================================
OWASP Top 10 [6890304962f5aa3c08a9ee01] โ ACTIVE
Documentation [6890304962f5aa3c08a9edfc] โ DRAFT
Zalando [6890304962f5aa3c08a9ee06] โ DRAFT
Versioning [6890304962f5aa3c08a9ee05] โ DRAFT
URL Style Guidelines [6890304962f5aa3c08a9ee04] โ DRAFT
Spell Check [6890304962f5aa3c08a9ee02] โ DISABLED
JSON API [6890304962f5aa3c08a9edff] โ ACTIVE
OWASP Top 10 2023 [6890304962f5aa3c08a9ee00] โ ACTIVE
Enforce HTTPs [6890304962f5aa3c08a9edfd] โ DRAFT
Security Best Practices [6890304962f5aa3c08a9eefe] โ ARCHIVED
Page 1 of 2 (Total: 15 policies)
Use --page 2 to see more results
โ 10 policy(ies) retrieved successfully.
Create and manage applications with their versions and packages. This complete lifecycle management enables you to organize APIs, track versions, and integrate OpenAPI specifications.
ata app create --project <PROJECT_ID> --team <TEAM_ID> --name <NAME> [options]
Create a new application in your project with configuration for deployment, technology stack, and integration settings.
# Basic application
ata app create --project 689c0a5b --team 68903049 --name "Payment API"
# Full configuration
ata app create \
--project 689c0a5b \
--team 68903049 \
--name "Payment Gateway API" \
--description "Secure payment processing service" \
--tech-stack BACKEND \
--tech-stack-data EXPRESS_JS \
--deployment-server SERVERLESS \
--git-tracking \
--git-url "https://github.com/myorg/payment-api.git"
ata app version-create --project <PROJECT_ID> --team <TEAM_ID> --application <APP_ID> --name <VERSION> [options]
Create versions for your applications to track changes and manage different releases.
# Basic version
ata app version-create \
--project 689c0a5b \
--team 68903049 \
--application 68cd3243a7e3cf \
--name "1.0.0"
# Version with policies
ata app version-create \
--project 689c0a5b \
--team 68903049 \
--application 68cd3243a7e3cf \
--name "2.0.0" \
--status DRAFT \
--policies "6890304962f5aa3c08a9ee01,6890304962f5aa3c08a9ee02"
ata app package-create --project <PROJECT_ID> --team <TEAM_ID> --application <APP_ID> --version <VERSION_ID> [options]
Create a package for an application version, optionally including OpenAPI specifications. The package can then be imported as a collection.
# Basic package
ata app package-create \
--project 689c0a5b \
--team 68903049 \
--application 68cd3243a7e3cf \
--version 68cd3244a7e3cf
# Package with OpenAPI spec
ata app package-create \
--project 689c0a5b \
--team 68903049 \
--application 68cd3243a7e3cf \
--version 68cd3244a7e3cf \
--openapi ./openapi.json
# The created package can be imported as a collection:
# ata collection import-package <PACKAGE_ID>
ata app package-publish <PACKAGE_ID> [options]
Publish a version package to make it active and available for deployments and imports. Publishing changes the package status from DRAFT to ACTIVE.
# Basic publish
ata app package-publish 68cb9143ce4b1689dfcb824c
# Publish with version and git info
ata app package-publish 68cb9143ce4b1689dfcb824c \
--version "2.0.0" \
--git-url "https://github.com/myorg/api.git" \
--branch "main" \
--tag "v2.0.0"
# Force publish without confirmation
ata app package-publish 68cb9143ce4b1689dfcb824c --force
ata app package-clone --version <VERSION_ID> --package <PACKAGE_ID>
Create a duplicate of an existing version package. This is useful for creating variants of a package or duplicating a package for different environments.
| Option | Description | Required |
|---|---|---|
--version <VERSION_ID> | Application version ID | Yes |
--package <PACKAGE_ID> | Package ID to clone | Yes |
ata app package-clone --version 68cd3244a7e3cf --package 68cb9143ce4b1689dfcb824c
โ Version package cloned successfully!
==============================================
Version Package Details
==============================================
Package ID: 68cd3245a7e3cf7b6b0e5f20
Application ID: 68cd3243a7e3cf7b6b0e5f1e
Version ID: 68cd3244a7e3cf
Version: 1.0.0
Status: DRAFT
You can now import this package as a collection using:
ata collection import-package 68cd3245a7e3cf7b6b0e5f20
ata app package-status --package <PACKAGE_ID> --status <STATUS>
Update the status of a version package. Common statuses include DRAFT, ACTIVE, ARCHIVED.
| Option | Description | Required |
|---|---|---|
--package <PACKAGE_ID> | Package ID | Yes |
--status <STATUS> | New status (e.g., DRAFT, ACTIVE, ARCHIVED) | Yes |
ata app package-status --package 68cb9143ce4b1689dfcb824c --status ACTIVE
โ Package status retrieved successfully!
==============================================
Version Package Details
==============================================
Package ID: 68cb9143ce4b1689dfcb824c
Application ID: 68cd3243a7e3cf7b6b0e5f1e
Version ID: 68cd3244a7e3cf
Version: 1.0.0
Status: ACTIVE
You can now import this package as a collection using:
ata collection import-package 68cb9143ce4b1689dfcb824c
ata app set-branch --package <PACKAGE_ID> --branch <BRANCH_NAME> [--environment <ENV_NAME>]
Configure Git branch settings for a package. This is essential for integrating with version control systems and is required before using magic-sync for design documentation and release notes.
| Option | Description | Required |
|---|---|---|
--package <PACKAGE_ID> | Package ID | Yes |
--branch <BRANCH_NAME> | Git branch name | Yes |
--environment <ENV_NAME> | Environment name (for environment-specific branches) | No |
# Set default branch for a package
ata app set-branch --package 68cb9143ce4b1689dfcb824c --branch main
# Set environment-specific branch
ata app set-branch --package 68cb9143ce4b1689dfcb824c --branch develop --environment dev
ata app set-branch --package 68cb9143ce4b1689dfcb824c --branch staging --environment uat
ata app set-branch --package 68cb9143ce4b1689dfcb824c --branch main --environment prod
โ Branch configuration updated successfully!
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Branch Configuration
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Package ID: 68cb9143ce4b1689dfcb824c
Environment: dev
Branch: develop
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
All Branch Configurations:
1. dev: develop
2. uat: staging
3. prod: main
magic-sync with --design-doc or --release-note optionsata app magic-sync --package <PACKAGE_ID> --application <APP_ID> --version <VERSION_ID> --project <PROJECT_ID> --team <TEAM_ID> [options]
Comprehensive synchronization tool for managing API collections, design documentation, and release notes. This powerful command automates multiple aspects of API lifecycle management.
| Option | Description |
|---|---|
--package <PACKAGE_ID> | Package ID |
--application <APP_ID> | Application ID |
--version <VERSION_ID> | Version ID |
--project <PROJECT_ID> | Project ID |
--team <TEAM_ID> | Team ID |
| Option | Description |
|---|---|
--api-collection | Sync API collection from OpenAPI spec |
--design-doc | Generate design documentation from GitHub repository |
--release-note | Generate AI-powered release notes |
--design-doc and --release-note: Git repository must be configured in the application--design-doc: Branch must be set using ata app set-branch commandSync API Collection Only
ata app magic-sync \
--package 68cd3244a7e3cf7b6b0e5f1f \
--application 68cd3243a7e3cf7b6b0e5f1e \
--version 68cd3244a7e3cf \
--project 689c0a5b251a3b05ffa18608 \
--team 68903049d0c5b7af278a038a \
--api-collection
Sync Design Documentation
# First, set the branch configuration (required)
ata app set-branch --package 68cd3244a7e3cf7b6b0e5f1f --branch main
# Then run magic-sync with design-doc
ata app magic-sync \
--package 68cd3244a7e3cf7b6b0e5f1f \
--application 68cd3243a7e3cf7b6b0e5f1e \
--version 68cd3244a7e3cf \
--project 689c0a5b251a3b05ffa18608 \
--team 68903049d0c5b7af278a038a \
--design-doc
Sync All Components
ata app magic-sync \
--package 68cd3244a7e3cf7b6b0e5f1f \
--application 68cd3243a7e3cf7b6b0e5f1e \
--version 68cd3244a7e3cf \
--project 689c0a5b251a3b05ffa18608 \
--team 68903049d0c5b7af278a038a \
--api-collection \
--design-doc \
--release-note
API Collection Sync:
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Magic Sync Initiated
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Team ID: 68903049d0c5b7af278a038a
Project ID: 689c0a5b251a3b05ffa18608
Application ID: 68cd3243a7e3cf7b6b0e5f1e
Version ID: 68cd3244a7e3cf
Package ID: 68cd3244a7e3cf7b6b0e5f1f
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Sync Operations:
โ API Collections
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ API Collections synced successfully!
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
API Collection Details
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Collection Name: Payment API Collection
Collection Type: SWAGGER
Collection ID: 68cd3246a7e3cf7b6b0e5f21
Version: 1.0.0
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Sync Summary
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
API Collections: โ Success
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Total: 1/1 operations completed successfully
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ All sync operations completed successfully!
Design Documentation Sync:
โ Design Documents sync initiated successfully!
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Design Documents Sync Details
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Repository: https://github.com/myorg/payment-api.git
Branch: main
Status: Processing in background
Note: Design document generation is running in the background.
Check your dashboard for completion status.
Release Notes Sync:
โ Release Notes sync initiated successfully!
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Release Notes Sync Details
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Release Note Type: FULL
Status: Processing in background
Note: Release notes generation is running in the background.
Check for the completion status.
set-branch commandata app security-insight --package <PACKAGE_ID> --project <PROJECT_ID> --team <TEAM_ID> [scan-options]
Perform comprehensive security scans on your application package. This command integrates multiple security scanning tools to identify vulnerabilities, secrets, license issues, and more.
| Option | Description |
|---|---|
--package <PACKAGE_ID> | Package ID to scan |
--project <PROJECT_ID> | Project ID |
--team <TEAM_ID> | Team ID |
| Option | Description |
|---|---|
--vulnerability | Scan for vulnerabilities in dependencies |
--secret-detection | Detect secrets and credentials in code |
--license-compliance | Check license compliance of dependencies |
--iac-security | Scan Infrastructure as Code (IaC) security issues |
--container-image | Scan container images for vulnerabilities |
--sast | Perform Static Application Security Testing (SAST) |
--all | Run all security scans |
ata app set-branch commandRun Vulnerability Scan Only
# First, set the branch configuration (required)
ata app set-branch --package 68cb9143ce4b1689dfcb824c --branch main --environment prod
# Run vulnerability scan
ata app security-insight \
--package 68cb9143ce4b1689dfcb824c \
--project 689c0a5b251a3b05ffa18608 \
--team 68903049d0c5b7af278a038a \
--vulnerability
Run Multiple Specific Scans
ata app security-insight \
--package 68cb9143ce4b1689dfcb824c \
--project 689c0a5b251a3b05ffa18608 \
--team 68903049d0c5b7af278a038a \
--vulnerability \
--secret-detection \
--license-compliance
Run All Security Scans
ata app security-insight \
--package 68cb9143ce4b1689dfcb824c \
--project 689c0a5b251a3b05ffa18608 \
--team 68903049d0c5b7af278a038a \
--all
Configuration Selection (Multiple Environments):
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Security Insight Initiated
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Valid configurations found:
1. ID: abc123, Environment: dev, Branch: develop
2. ID: def456, Environment: prod, Branch: main
? Select environment and branch configuration: (Use arrow keys)
โฏ dev - develop
prod - main
Scan Execution:
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Package ID: 68cb9143ce4b1689dfcb824c
Repository: https://github.com/myorg/payment-api.git
Environment: prod
Branch: main
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Security Scans:
โ Vulnerability Scan
โ Secret Detection
โ License Compliance
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Vulnerability scan completed successfully!
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Vulnerability Scan Results
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Total Vulnerabilities: 12
Critical: 2
High: 4
Medium: 5
Low: 1
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Secret detection scan completed successfully!
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Secret Detection Results
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Total: 3
Critical: 1
High: 2
Medium: 0
Low: 0
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ License compliance scan completed successfully!
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
License Compliance Results
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Total: 45
Critical: 0
High: 0
Medium: 2
Low: 3
Good: 40
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Scan Summary
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Vulnerability Scan: โ Success
Secret Detection: โ Success
License Compliance: โ Success
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Total: 3/3 scans completed successfully
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ All security scans completed successfully!
Vulnerability Scanning
Secret Detection
License Compliance
IaC Security
Container Image Scanning
SAST (Static Application Security Testing)
set-branch commandata app access-request \
--team <TEAM_ID> \
--project <PROJECT_ID> \
--application <APP_ID> \
--appVersion <VERSION_ID> \
--type <TYPE> \
--requestTeam <REQUEST_TEAM_ID> \
--requestProject <REQUEST_PROJECT_ID> \
--requestApplication <REQUEST_APP_ID> \
--requestType <REQUEST_TYPE> \
[type-specific-options]
Create API access requests for applications to request access to other APIs or services. This enables proper access control and dependency management between applications.
| Option | Description | Values |
|---|---|---|
--team <TEAM_ID> | Team ID making the request | Team ID string |
--project <PROJECT_ID> | Project ID | Project ID string |
--application <APP_ID> | Application ID requesting access | Application ID string |
--appVersion <VERSION_ID> | Application version ID | Version ID string |
--type <TYPE> | Access request type | CONSUMER, DEPENDENT_ON |
--requestTeam <TEAM_ID> | Target resource team ID | Team ID string |
--requestProject <PROJECT_ID> | Target resource project ID | Project ID string |
--requestType <TYPE> | Type of resource being requested | API, SERVICE |
| Option | Description | Required For |
|---|---|---|
--requestApplication <APP_ID> | Target application ID | CONSUMER type and DEPENDENT_ON with API (optional for DEPENDENT_ON with SERVICE) |
--apiInfo <API_INFO_ID> | API Info ID | CONSUMER type only |
--requestApi <API_ID> | Target API ID | API request type |
--requestVersion <VERSION_ID> | Target API version ID | API request type |
--service <SERVICE_ID> | Service ID | SERVICE request type |
--serviceList <IDs> | Comma-separated service list IDs | SERVICE request type |
CONSUMER Type
--apiInfo parameter--requestType must be APIDEPENDENT_ON Type
Example 1: CONSUMER Type (API Access)
ata app access-request \
--team "690b009797745f554ec67540" \
--project "690b00ea1ea8bdc5de00020a" \
--application "692d45dc10e93f885d9e7e52" \
--appVersion "692d45dc10e93f885d9e7e56" \
--type "CONSUMER" \
--apiInfo "692ec3ba736b19ff741248e5" \
--requestTeam "690b009797745f554ec67540" \
--requestProject "690b00ea1ea8bdc5de00020a" \
--requestApplication "692fcbf90834ecb3fa80bc39" \
--requestType "API" \
--requestApi "692fcc5a0834ecb3fa80bcc3" \
--requestVersion "692fcbf90834ecb3fa80bc3d"
Example 2: DEPENDENT_ON Type (API Access)
ata app access-request \
--team "690b009797745f554ec67540" \
--project "690b00ea1ea8bdc5de00020a" \
--application "692d6af310e93f885d9e868d" \
--appVersion "692d6af310e93f885d9e8691" \
--type "DEPENDENT_ON" \
--requestTeam "690b009797745f554ec67540" \
--requestProject "690b00ea1ea8bdc5de00020a" \
--requestApplication "692fcbf90834ecb3fa80bc39" \
--requestType "API" \
--requestApi "692fcc5a0834ecb3fa80bcc3" \
--requestVersion "692fcbf90834ecb3fa80bc3d"
Example 3: DEPENDENT_ON Type (Service Access)
ata app access-request \
--team "690b009797745f554ec67540" \
--project "690b00ea1ea8bdc5de00020a" \
--application "69253a761920787f2fb4658f" \
--appVersion "69253a761920787f2fb46593" \
--type "DEPENDENT_ON" \
--requestTeam "690b009797745f554ec67540" \
--requestProject "690b00ea1ea8bdc5de00020a" \
--requestType "SERVICE" \
--service "6916faa3c070332b7dd0c6c1" \
--serviceList "6916fad1c070332b7dd0c6c6,6916fad1c070332b7dd0c6c7"
CONSUMER Type Request:
โ Access request created successfully!
==============================================
Access Request Details
==============================================
Type: CONSUMER
Team: 690b009797745f554ec67540
Project: 690b00ea1ea8bdc5de00020a
Application: 692d45dc10e93f885d9e7e52
App Version: 692d45dc10e93f885d9e7e56
Request ID: 694abc123def456789012345
--- Request Details ---
API Info: 692ec3ba736b19ff741248e5
Request Type: API
Request Team: 690b009797745f554ec67540
Request Project: 690b00ea1ea8bdc5de00020a
Request Application: 692fcbf90834ecb3fa80bc39
Request API: 692fcc5a0834ecb3fa80bcc3
Request Version: 692fcbf90834ecb3fa80bc3d
==============================================
SERVICE Type Request:
โ Access request created successfully!
==============================================
Access Request Details
==============================================
Type: DEPENDENT_ON
Team: 690b009797745f554ec67540
Project: 690b00ea1ea8bdc5de00020a
Application: 69253a761920787f2fb4658f
App Version: 69253a761920787f2fb46593
Request ID: 694xyz789abc012345678901
--- Request Details ---
Request Type: SERVICE
Request Team: 690b009797745f554ec67540
Request Project: 690b00ea1ea8bdc5de00020a
Service: 6916faa3c070332b7dd0c6c1
Service List: 6916fad1c070332b7dd0c6c6,6916fad1c070332b7dd0c6c7
==============================================
| Field | CONSUMER + API | DEPENDENT_ON + API | DEPENDENT_ON + SERVICE |
|---|---|---|---|
--team | โ Required | โ Required | โ Required |
--project | โ Required | โ Required | โ Required |
--application | โ Required | โ Required | โ Required |
--appVersion | โ Required | โ Required | โ Required |
--type | โ CONSUMER | โ DEPENDENT_ON | โ DEPENDENT_ON |
--apiInfo | โ Required | โ Not used | โ Not used |
--requestTeam | โ Required | โ Required | โ Required |
--requestProject | โ Required | โ Required | โ Required |
--requestApplication | โ Required | โ Required | โช Optional |
--requestType | โ Must be API | โ API | โ SERVICE |
--requestApi | โ Required | โ Required | โ Not used |
--requestVersion | โ Required | โ Required | โ Not used |
--service | โ Not used | โ Not used | โ Required |
--serviceList | โ Not used | โ Not used | โ Required |
Consumer Access Requests
Dependency Management
Service Access
ata loginata app access-request-list [OPTIONS]
List and browse API access requests with filtering and pagination support. View requests you've made or requests made to your APIs.
| Option | Description | Default |
|---|---|---|
--page <page> | Page number for pagination | 1 |
--size <size> | Number of requests per page | 10 |
--requestFor <requestFor> | Filter by request direction | - |
--team <teamId> | Filter by team ID | - |
--project <projectId> | Filter by project ID | - |
| Value | Description |
|---|---|
BY_ME | Show access requests you have created |
TO_ME | Show access requests made to your APIs/services |
List All Access Requests (Default)
ata app access-request-list
List Requests You've Made
ata app access-request-list --requestFor BY_ME
List Requests Made to Your APIs
ata app access-request-list --requestFor TO_ME
Filter by Team and Project
ata app access-request-list \
--team "690b009797745f554ec67540" \
--project "690b00ea1ea8bdc5de00020a"
List with Pagination
# First page with 20 items
ata app access-request-list --page 1 --size 20
# Second page
ata app access-request-list --page 2 --size 20
Combined Filters
ata app access-request-list \
--requestFor BY_ME \
--team "690b009797745f554ec67540" \
--project "690b00ea1ea8bdc5de00020a" \
--page 1 \
--size 15
==============================================
API Access Requests
==============================================
Filters:
Request For: BY_ME
Team: 690b009797745f554ec67540
Total: 25 request(s)
Page 1 of 3
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
1. Request ID: 694abc123def456789012345
Type: CONSUMER
Status: APPROVED
Application: Payment Gateway API
Version: 1.0.0
Team: 690b009797745f554ec67540
Project: 690b00ea1ea8bdc5de00020a
Requests: 1 item(s)
- API Info: 692ec3ba736b19ff741248e5
โข Type: API
API: 692fcc5a0834ecb3fa80bcc3
Created: 1/20/2025, 10:30:45 AM
Updated: 1/20/2025, 11:15:22 AM
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
2. Request ID: 694xyz789abc012345678901
Type: DEPENDENT_ON
Status: PENDING
Application: Auth Service
Version: 2.0.0
Team: 690b009797745f554ec67540
Project: 690b00ea1ea8bdc5de00020a
Requests: 1 item(s)
โข Type: SERVICE
Service: 6916faa3c070332b7dd0c6c1
Created: 1/19/2025, 3:45:12 PM
Updated: 1/19/2025, 3:45:12 PM
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
3. Request ID: 694def456ghi789012345678
Type: DEPENDENT_ON
Status: REJECTED
Application: Mobile App
Version: 3.0.0
Team: 690b009797745f554ec67540
Project: 690b00ea1ea8bdc5de00020a
Requests: 1 item(s)
โข Type: API
API: 692fcc5a0834ecb3fa80bcc3
Created: 1/18/2025, 9:20:33 AM
Updated: 1/18/2025, 2:30:15 PM
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Showing page 1 of 3
Use --page 2 to see more results
==============================================
| Status | Description | Color |
|---|---|---|
APPROVED | Request has been approved | Green |
PENDING | Request is awaiting approval | Yellow |
REJECTED | Request has been rejected | Red |
Monitor Your Requests
# Check status of all requests you've made
ata app access-request-list --requestFor BY_ME
Review Incoming Requests
# See who is requesting access to your APIs
ata app access-request-list --requestFor TO_ME
Project-Specific Access Management
# View all access requests for a specific project
ata app access-request-list --project "690b00ea1ea8bdc5de00020a"
Team Collaboration
# Review all team access requests
ata app access-request-list --team "690b009797745f554ec67540"
--requestFor values trigger validation errorsata loginata app access-request-review --accessRequestId <REQUEST_ID> --status <STATUS>
Approve or reject API access requests. This command allows authorized users to review and respond to access requests made to their APIs or services.
| Option | Description | Values |
|---|---|---|
--accessRequestId <REQUEST_ID> | Access request ID to review | Request ID string |
--status <STATUS> | Review decision | APPROVED, REJECTED |
Approve an Access Request
ata app access-request-review \
--accessRequestId "6932b0e1889fe4e81fd3ea20" \
--status APPROVED
Reject an Access Request
ata app access-request-review \
--accessRequestId "6932b0e1889fe4e81fd3ea20" \
--status REJECTED
Successful Approval:
โ Access request approved successfully!
==============================================
Access Request Review
==============================================
Request ID: 6932b0e1889fe4e81fd3ea20
New Status: APPROVED
Updated Request ID: 6932b0e1889fe4e81fd3ea20
Type: CONSUMER
Application: Payment Gateway API
Version: 1.0.0
Team: 690b009797745f554ec67540
Project: 690b00ea1ea8bdc5de00020a
Updated At: 1/20/2025, 2:45:30 PM
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
The requesting application now has access to the requested resources.
==============================================
Successful Rejection:
โ Access request rejected successfully!
==============================================
Access Request Review
==============================================
Request ID: 6932b0e1889fe4e81fd3ea20
New Status: REJECTED
Updated Request ID: 6932b0e1889fe4e81fd3ea20
Type: DEPENDENT_ON
Application: Mobile App
Version: 2.0.0
Team: 690b009797745f554ec67540
Project: 690b00ea1ea8bdc5de00020a
Updated At: 1/20/2025, 2:50:15 PM
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
The access request has been rejected. The requesting application does not have access.
==============================================
| Status | Description | Effect |
|---|---|---|
APPROVED | Grant access to the requested resources | The requesting application can now access the API/service |
REJECTED | Deny access to the requested resources | The requesting application cannot access the API/service |
Typical Review Workflow:
# 1. List incoming access requests
ata app access-request-list --requestFor TO_ME
# 2. Review the request details and decide
# 3. Approve the request
ata app access-request-review \
--accessRequestId "6932b0e1889fe4e81fd3ea20" \
--status APPROVED
# 4. Verify the updated status
ata app access-request-list --requestFor TO_ME
API Provider Approval
Access Management
Team Collaboration
Request Not Found (404)
โ Error: Not Found
Access request with ID "6932b0e1889fe4e81fd3ea20" not found.
Please verify the request ID and try again.
Permission Denied (403)
โ Error: Forbidden
You do not have permission to review this access request.
Only authorized users can approve or reject access requests.
Already Reviewed (400)
โ Error: Bad Request
Invalid request. The access request may already be reviewed.
Invalid Status
Invalid status value. Must be either APPROVED or REJECTED
ata login# 1. Create an application with Git tracking
ata app create --project PROJECT_ID --team TEAM_ID --name "My API" \
--git-tracking --git-url "https://github.com/myorg/my-api.git"
# Returns: Application ID
# 2. Create a version
ata app version-create --project PROJECT_ID --team TEAM_ID \
--application APP_ID --name "1.0.0"
# Returns: Version ID
# 3. Create a package with OpenAPI spec
ata app package-create --project PROJECT_ID --team TEAM_ID \
--application APP_ID --version VERSION_ID --openapi ./spec.json
# Returns: Package ID
# 4. Set branch configuration (required for magic-sync and security insights)
ata app set-branch --package PACKAGE_ID --branch main --environment prod
# 5. Create access requests for API dependencies
ata app access-request --team TEAM_ID --project PROJECT_ID \
--application APP_ID --appVersion VERSION_ID --type DEPENDENT_ON \
--requestTeam REQ_TEAM_ID --requestProject REQ_PROJECT_ID \
--requestApplication REQ_APP_ID --requestType API \
--requestApi API_ID --requestVersion API_VERSION_ID
# 6. Run magic sync to generate API collections, docs, and release notes
ata app magic-sync --package PACKAGE_ID --application APP_ID \
--version VERSION_ID --project PROJECT_ID --team TEAM_ID \
--api-collection --design-doc --release-note
# 7. Run comprehensive security scans
ata app security-insight --package PACKAGE_ID --project PROJECT_ID \
--team TEAM_ID --all
# 8. Change package status if needed
ata app package-status --package PACKAGE_ID --status ACTIVE
# 9. Publish the package to make it live
ata app package-publish PACKAGE_ID --version "1.0.0"
# 10. Clone package for another environment if needed
ata app package-clone --version VERSION_ID --package PACKAGE_ID
# Returns: New Package ID
# 11. Import the package as a collection for testing
ata collection import-package PACKAGE_ID
ata logout โ Log out and remove stored login informationata update โ Update ATA CLI to the latest versionContributions, issues, and feature requests are welcome! Please see the issues page or submit a pull request.
For help or questions, please visit the AllThingsAPI website or contact support.
ยฉ 2025 AllThingsAPI
FAQs
A professional command-line interface (CLI) for API testing, validation, and management. Enables developers to validate OpenAPI specifications, lint API designs, and manage API workflows directly from the terminal with an efficient, developer-friendly exp
The npm package @allthingsapi/ata-cli receives a total of 46 weekly downloads. As such, @allthingsapi/ata-cli popularity was classified as not popular.
We found that @allthingsapi/ata-cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.ย It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
GemStuffer abuses RubyGems as an exfiltration channel, packaging scraped UK council portal data into junk gems published from new accounts.
Company News
Socket was named to the Rising in Cyber 2026 list, recognizing 30 private cybersecurity startups selected by CISOs and security executives.
Research
Socket detected 84 compromised TanStack npm package artifacts modified with suspected CI credential-stealing malware.