API & CLI
Automate Argy beyond the UI: REST API and command-line tool.
Argy is designed to be API-first. Everything that can be done in the Argy portal can also be achieved through our API or our command-line tool (CLI).
Argy CLI
The Argy CLI allows developers and platform teams to interact with the IDP directly from their terminal or CI/CD pipelines.
Installation
The CLI is provided to Argy customers and can be installed from your Argy workspace (or distributed through your internal package workflows).
Common Commands
- Authenticate via SSO.
- List available golden paths.
- Initialize a product (e.g., service, pipeline) from a pattern.
- Trigger a run (deployment, provisioning, SRE routine) based on your configuration.
REST API
For more advanced integrations, Argy exposes a full REST API documented via OpenAPI/Swagger.
Authentication
The API integrates with your identity model (SSO) and supports automation-friendly access mechanisms (application tokens).
Request Example
Conceptual example: create or update a product, then trigger a run via an authenticated request.
Exact endpoints and full examples are available in your tenant’s OpenAPI documentation.
CI/CD Integrations
The Argy CLI is optimized for use in CI environments (GitHub Actions, GitLab Runner, Jenkins). It provides JSON output to facilitate result processing and workflow automation.