Managing API keys

You need to create an API key to allow external systems to run compute on Flyte, e.g. a GitHub action that registers or runs workflows.

Creating an API key

To create an API key, run the following with the Pyflyte CLI with any name.

$ pyflyte create api-key admin --name my-custom-name

Client ID: my-custom-name
The following API key will only be shown once. Be sure to keep it safe!
Configure your headless CLI by setting the following environment variable:

export FLYTE_API_KEY="<SECRET>"

Store the <SECRET> in a secure location. For git development, make sure to not check in the <SECRET> into your repository. Within a GitHub action, you can use Github Secrets to store the secret.

For this example, copy the following workflow into a file called hello.py:

import flytekit as fl

@fl.task
def welcome(name: str) -> str:
    return f"Welcome to Flyte! {name}"

@fl.workflow
def main(name: str) -> str:
    return welcome(name=name)

You can run this workflow from any machine by setting the FLYTE_API_KEY environment variable:

$ export FLYTE_API_KEY="<SECRET>"
$ pyflyte run --remote hello.py main --name "Flyte"

Listing and deleting applications

You can list all your application by running:

$ pyflyte get api-key admin

┏━━━━━━━━━━━━━━━━┓
┃ client_id      ┃
┡━━━━━━━━━━━━━━━━┩
│ my-custom-name │
└────────────────┘

The client_id contains your custom application name and a prefix that contains your username.

Finally, you can delete your application by running:

$ pyflyte delete api-key admin --name my-custom-name