# Flyte Admin Service API

**Canonical:** https://apis.io/apis/flyte/flyte-adminservice-api/  
**Provider:** Flyte — https://apis.io/providers/flyte/  
**Base URL:** http://localhost:30080  
**Documentation:** https://docs.flyte.org

Flyte Admin Service API is published by [Flyte](https://apis.io/providers/flyte/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Admin Service. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

The AdminService API from Flyte — 49 operation(s) for adminservice.

## Operations (57)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/active_launch_plans/{id.project}/{id.domain}/{id.name}` | Fetch the active version of a :ref:`ref_flyteidl.admin.LaunchPlan` |
| GET | `/api/v1/active_launch_plans/{project}/{domain}` | List active versions of :ref:`ref_flyteidl.admin.LaunchPlan` |
| GET | `/api/v1/children/task_executions/{task_execution_id.node_execution_id.execution_id.project}/{task_execution_id.node_execution_id.execution_id.domain}/{task_execution_id.node_execution_id.execution_id.name}/{task_execution_id.node_execution_id.node_id}/{task_execution_id.task_id.project}/{task_execution_id.task_id.domain}/{task_execution_id.task_id.name}/{task_execution_id.task_id.version}/{task_execution_id.retry_attempt}` | Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution` launched by the… |
| GET | `/api/v1/data/executions/{id.project}/{id.domain}/{id.name}` | Fetches input and output data for a :ref:`ref_flyteidl.admin.Execution` |
| GET | `/api/v1/data/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}` | Fetches input and output data for a :ref:`ref_flyteidl.admin.NodeExecution` |
| GET | `/api/v1/data/task_executions/{id.node_execution_id.execution_id.project}/{id.node_execution_id.execution_id.domain}/{id.node_execution_id.execution_id.name}/{id.node_execution_id.node_id}/{id.task_id.project}/{id.task_id.domain}/{id.task_id.name}/{id.task_id.version}/{id.retry_attempt}` | Fetches input and output data for a :ref:`ref_flyteidl.admin.TaskExecution` |
| GET | `/api/v1/description_entities/{id.resource_type}/{id.project}/{id.domain}/{id.name}/{id.version}` | Fetch a :ref:`ref_flyteidl.admin.DescriptionEntity` object |
| GET | `/api/v1/description_entities/{resource_type}/{id.project}/{id.domain}` | Fetch a list of :ref:`ref_flyteidl.admin.DescriptionEntity` definitions |
| GET | `/api/v1/description_entities/{resource_type}/{id.project}/{id.domain}/{id.name}` | Fetch a list of :ref:`ref_flyteidl.admin.DescriptionEntity` definitions |
| POST | `/api/v1/events/nodes` | Indicates a :ref:`ref_flyteidl.event.NodeExecutionEvent` has occurred |
| POST | `/api/v1/events/tasks` | Indicates a :ref:`ref_flyteidl.event.TaskExecutionEvent` has occurred |
| POST | `/api/v1/events/workflows` | Indicates a :ref:`ref_flyteidl.event.WorkflowExecutionEvent` has occurred |
| POST | `/api/v1/executions` | Triggers the creation of a :ref:`ref_flyteidl.admin.Execution` |
| POST | `/api/v1/executions/recover` | Recreates a previously-run workflow execution that will only start executing… |
| POST | `/api/v1/executions/relaunch` | Triggers the creation of an identical :ref:`ref_flyteidl.admin.Execution` |
| GET | `/api/v1/executions/{id.project}/{id.domain}` | Fetch a list of :ref:`ref_flyteidl.admin.Execution` |
| GET | `/api/v1/executions/{id.project}/{id.domain}/{id.name}` | Fetches a :ref:`ref_flyteidl.admin.Execution` |
| DELETE | `/api/v1/executions/{id.project}/{id.domain}/{id.name}` | Terminates an in-progress :ref:`ref_flyteidl.admin.Execution` |
| PUT | `/api/v1/executions/{id.project}/{id.domain}/{id.name}` | Update execution belonging to project domain :ref:`ref_flyteidl.admin.Execution` |
| GET | `/api/v1/launch_plan_ids/{project}/{domain}` | Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of launch plan… |
| POST | `/api/v1/launch_plans` | Create and upload a :ref:`ref_flyteidl.admin.LaunchPlan` definition |
| GET | `/api/v1/launch_plans/{id.project}/{id.domain}` | Fetch a list of :ref:`ref_flyteidl.admin.LaunchPlan` definitions |
| GET | `/api/v1/launch_plans/{id.project}/{id.domain}/{id.name}` | Fetch a list of :ref:`ref_flyteidl.admin.LaunchPlan` definitions |
| GET | `/api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version}` | Fetch a :ref:`ref_flyteidl.admin.LaunchPlan` definition |
| PUT | `/api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version}` | Updates the status of a registered :ref:`ref_flyteidl.admin.LaunchPlan` |
| GET | `/api/v1/matchable_attributes` | Lists custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a… |
| GET | `/api/v1/metrics/executions/{id.project}/{id.domain}/{id.name}` | Fetches runtime metrics for a :ref:`ref_flyteidl.admin.Execution` |
| GET | `/api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name}` | Returns a :ref:`ref_flyteidl.admin.NamedEntity` object |
| PUT | `/api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name}` | Updates a :ref:`ref_flyteidl.admin.NamedEntity` object |
| GET | `/api/v1/named_entities/{resource_type}/{project}/{domain}` | Returns a list of :ref:`ref_flyteidl.admin.NamedEntity` objects |
| GET | `/api/v1/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}` | Fetches a :ref:`ref_flyteidl.admin.NodeExecution` |
| GET | `/api/v1/node_executions/{workflow_execution_id.project}/{workflow_execution_id.domain}/{workflow_execution_id.name}` | Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution` |
| PUT | `/api/v1/project_attributes/{attributes.project}` | Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfigurat… |
| GET | `/api/v1/project_attributes/{project}` | Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a… |
| DELETE | `/api/v1/project_attributes/{project}` | Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a… |
| PUT | `/api/v1/project_domain_attributes/{attributes.project}/{attributes.domain}` | Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfigurat… |
| GET | `/api/v1/project_domain_attributes/{project}/{domain}` | Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a… |
| DELETE | `/api/v1/project_domain_attributes/{project}/{domain}` | Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a… |
| GET | `/api/v1/projects` | Fetches a list of :ref:`ref_flyteidl.admin.Project` |
| POST | `/api/v1/projects` | Registers a :ref:`ref_flyteidl.admin.Project` with the Flyte deployment |
| PUT | `/api/v1/projects/{id}` | Updates an existing :ref:`ref_flyteidl.admin.Project` flyteidl.admin.Project… |
| GET | `/api/v1/task_executions/{id.node_execution_id.execution_id.project}/{id.node_execution_id.execution_id.domain}/{id.node_execution_id.execution_id.name}/{id.node_execution_id.node_id}/{id.task_id.project}/{id.task_id.domain}/{id.task_id.name}/{id.task_id.version}/{id.retry_attempt}` | Fetches a :ref:`ref_flyteidl.admin.TaskExecution` |
| GET | `/api/v1/task_executions/{node_execution_id.execution_id.project}/{node_execution_id.execution_id.domain}/{node_execution_id.execution_id.name}/{node_execution_id.node_id}` | Fetches a list of :ref:`ref_flyteidl.admin.TaskExecution` |
| GET | `/api/v1/task_ids/{project}/{domain}` | Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of task objects |
| POST | `/api/v1/tasks` | Create and upload a :ref:`ref_flyteidl.admin.Task` definition |
| GET | `/api/v1/tasks/{id.project}/{id.domain}` | Fetch a list of :ref:`ref_flyteidl.admin.Task` definitions |
| GET | `/api/v1/tasks/{id.project}/{id.domain}/{id.name}` | Fetch a list of :ref:`ref_flyteidl.admin.Task` definitions |
| GET | `/api/v1/tasks/{id.project}/{id.domain}/{id.name}/{id.version}` | Fetch a :ref:`ref_flyteidl.admin.Task` definition |
| GET | `/api/v1/version` | Get version |
| PUT | `/api/v1/workflow_attributes/{attributes.project}/{attributes.domain}/{attributes.workflow}` | Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfigurat… |
| GET | `/api/v1/workflow_attributes/{project}/{domain}/{workflow}` | Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a… |
| DELETE | `/api/v1/workflow_attributes/{project}/{domain}/{workflow}` | Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a… |
| GET | `/api/v1/workflow_ids/{project}/{domain}` | Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of workflow… |
| POST | `/api/v1/workflows` | Create and upload a :ref:`ref_flyteidl.admin.Workflow` definition |
| GET | `/api/v1/workflows/{id.project}/{id.domain}` | Fetch a list of :ref:`ref_flyteidl.admin.Workflow` definitions |
| GET | `/api/v1/workflows/{id.project}/{id.domain}/{id.name}` | Fetch a list of :ref:`ref_flyteidl.admin.Workflow` definitions |
| GET | `/api/v1/workflows/{id.project}/{id.domain}/{id.name}/{id.version}` | Fetch a :ref:`ref_flyteidl.admin.Workflow` definition |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/flyte/refs/heads/main/openapi/flyte-adminservice-api-openapi.yml
- **Documentation** — https://docs.flyte.org
- **GitHubRepository** — https://github.com/flyteorg/flyte
- **SourceSwagger** — https://raw.githubusercontent.com/flyteorg/flyteidl/master/gen/pb-go/flyteidl/service/admin.swagger.json
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/flyte/refs/heads/main/apis.yml

## Tags

Admin Service

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/flyte/flyte-adminservice-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/flyte/.