Skip to main content

Otoroshi deployments

you can link your Cloud APIM account into your otoroshictl config, just do

$ otoroshictl cloud-apim login

otoroshictl shows a code and opens the console in a web browser: check that the console shows the same code, choose the organisation and what otoroshictl may do (read, act on the instances, read their secrets to link them), then approve. otoroshictl gets a personal token of the public API of Cloud APIM, valid 30 days, that you can revoke from your account in the console. On a machine without a browser, set OTOROSHICTL_NO_BROWSER=1 and open the page it prints yourself.

Once logged in, you can list the managed Otoroshi instances of your organisations

$ otoroshictl cloud-apim list

+------------+--------------+---------+---------+--------+------+--------------------------+-------------------------+
| name       | organisation | version | status  | region | plan | created_at               | id                      |
+------------+--------------+---------+---------+--------+------+--------------------------+-------------------------+
| Production | Acme         | 17.16.0 | running | par    | Prod | 2026-10-08T19:22:26.824Z | mi_vfpcogd0y3egd5ldlxj5 |
+------------+--------------+---------+---------+--------+------+--------------------------+-------------------------+

and then link one to your otoroshictl config (by its name, or by its id when two organisations have an instance of the same name)

$ otoroshictl cloud-apim link Production

otoroshictl cloud-apim logout revokes the token and forgets it. CLOUD_APIM_API_URL points otoroshictl to another console (https://console-next.cloud-apim.com by default).

Cloud APIM subcommands​

$ otoroshictl cloud-apim -ht

Manage cloud apim clusters

Usage: otoroshictl cloud-apim [OPTIONS] <COMMAND>

Commands:
login    Login to your cloud-apim account
list     List your managed Otoroshi instances
logout   Logout from your cloud-apim account
link     Add the cluster to the possible otoroshictl configs
use      Add the cluster to the possible otoroshictl configs and set it as the current one
restart  Restart this otoroshi cluster on cloud-apim
help     Print this message or the help of the given subcommand(s)

Options:
-v, --verbose
        Turn debugging information on
-o, --ouput <FORMAT>
        Change the rendering format (can be one of: json, yaml, json_pretty)
-c, --config-file <FILE or URL>
        Sets a custom config file
    --otoroshi-cluster-tls
        Sets the tls flag to connect to a custom otoroshi cluster without using a config file
    --otoroshi-cluster-hostname <HOSTNAME>
        Sets the hostname to connect to a custom otoroshi cluster without using a config file
    --otoroshi-cluster-port <PORT>
        Sets the port to connect to a custom otoroshi cluster without using a config file
    --otoroshi-cluster-routing-tls
        Sets the tls flag to connect to a custom otoroshi cluster without using a config file
    --otoroshi-cluster-routing-hostname <HOSTNAME>
        Sets the hostname to connect to a custom otoroshi cluster without using a config file
    --otoroshi-cluster-routing-port <PORT>
        Sets the port to connect to a custom otoroshi cluster without using a config file
    --otoroshi-user-client-id <CLIENT_ID>
        Sets the client_id to connect to a custom otoroshi cluster without using a config file
    --otoroshi-user-client-secret <CLIENT_SECRET>
        Sets the client_secret to connect to a custom otoroshi cluster without using a config file
    --otoroshi-user-health-key <HEALTH_KEY>
        Sets the health_key to connect to a custom otoroshi cluster without using a config file
    --otoroshi-cluster-cert-location <FILE>
        Sets the client cert location to connect to a custom otoroshi cluster without using a config file
    --otoroshi-cluster-key-location <FILE>
        Sets the client cert key location to connect to a custom otoroshi cluster without using a config file
    --otoroshi-cluster-ca-location <FILE>
        Sets the client cert ca location to connect to a custom otoroshi cluster without using a config file
-h, --help
        Print help