apicops is a command line interface to IBM API Connect v2018 specifically targetted at Operations teams. It contains commands to check the healthy running of the system as well as some commands to remedy specific problems if encountered.
It is in active development and new versions will be posted here regularly. All suggestions, feedback and bug reports are welcome - please feel free to raise an issue in this repository. Please limit the issues to those specific to apicops itself - we cannot accept ones about APIC, they have to be raised via the normal IBM Support route.
Please note this has only been tested against IBM API Connect v2018.4.1.6+.
Unless directed by IBM, only run commands that are also described in the Knowledge Center:
Download the latest binary for your operating system from the Releases tab and rename it to be apicops. Note that Linux and Mac will require you to run chmod +x on the downloaded file before you can execute it.
In order to run apicops you need to have kubectl or something that implements the same CLI as kubectl, such as oc installed locally. If you aren't using kubectl then set the environment variable APICOPS_K8SCLIENT to the name of the Kubernetes client binary, such as oc.
If using the openshift client (oc) then v4.1.x or greater is required (even if using v3.x openshift cluster).
Then set the KUBECONFIG environment variable to point to your kubeconfig file and apicops will pick it up from there.
$ export KUBECONFIG=/home/user/my.kubeconfig
$ apicopsIf running inside an API Connect OVA file then run apicops as root (sudo -i) and it will automatically pick up the kubeconfig.
The default namespace for the deployment will be targeted by default. If your deployment makes use of an alternative namespace then you will need to set this in the relevant context of your kubeconfig file.
Your can either edit your kubeconfig file directly and add the namespace property with the desired value to the relevant context.
Alternatively you can set the namespace for the current context using the following command (where < namespace > is the value you want to set the namespace to):
kubectl config set "contexts."`kubectl config current-context`".namespace" < namespace >
You can view all contexts and their configured namespace with the command:
kubectl config get-contexts
$ apicops COMMAND
running command...
$ apicops (-v|--version|version)
apicops/0.1.46 linux-x64 node-v10.16.3
$ apicops --help [COMMAND]
USAGE
$ apicops COMMAND
...apicops catalogs:get CATALOGapicops catalogs:listapicops cron-jobs:recreateapicops custom:run SCRIPT [PARAMS]apicops grace-period:getapicops grace-period:set PERIODapicops help [COMMAND]apicops locks:delete-expiredapicops oauth-secret:fix URLapicops organisations:get ORGapicops organisations:listapicops services:get-configured-gateway GATEWAYapicops services:get-configured-portal PORTALapicops services:get-gateway GATEWAYapicops services:identify-stateapicops services:list-configured-gatewayapicops services:list-configured-portalapicops services:list-gatewaysapicops snapshots:build URLapicops snapshots:check-invalid-products URLapicops snapshots:check-invalid-products-gateway URLapicops snapshots:fix-invalid-products CATALOGapicops snapshots:fix-invalid-products-gateway URLapicops snapshots:send SERVICEapicops snapshots:validate CATALOGapicops spaces:get SPACEapicops spaces:listapicops subscriber-queues:clearapicops subscriber-queues:get-length SUBSCRIBERapicops tables:check-indexapicops tables:check-linkapicops tables:get-contents [TABLE] [CHUNKSIZE]apicops tables:list-sizes [KEYSPACE]apicops tables:rebuild-indexes [TABLE]apicops task-queue:clearapicops tasks:create-gateway GATEWAYapicops tasks:create-portal PORTALapicops tasks:get TASKIDapicops tasks:listapicops tasks:renew TASKIDapicops webhook-subscriptions:check-orphansapicops webhook-subscriptions:delete-orphansapicops webhook-subscriptions:listapicops webhook-subscriptions:mark-gateway URLORIDapicops webhook-subscriptions:mark-portal URLORID
(cat) Looks up a specific catalog based on uuid or name
USAGE
$ apicops catalogs:get CATALOG
ARGUMENTS
CATALOG The id or name of the catalog
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops cat
EXAMPLES
$ apicops cat 4eab42d5-6ba8-4e68-ac87-44ff229db677 # Get a catalog by UUID
$ apicops cat cbd062ad-f04c-44cd-afae-dd6a9247309c:sandbox # Get a catalog using the org UUID and catalog name
$ apicops catalogs:get myuniqueorg/stuff # Get a catalog using the org name and catalog name
$ apicops catalogs:get myuniquecat # Get a catalog using the unique catalog name
$ apicops catalogs:get sandbox # Get all catalogs named sandbox
See code: src/commands/catalogs/get.js
(cats) Lists all catalogs
USAGE
$ apicops catalogs:list
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops cats
EXAMPLES
$ apicops catalogs:list # List all catalogs
$ apicops cats # List all catalogs
See code: src/commands/catalogs/list.js
(cronjobs) Recreate the apim cron jobs
USAGE
$ apicops cron-jobs:recreate
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops cronjobs
EXAMPLES
$ apicops cron-jobs:recreate # Recreate the apim cron jobs
$ apicops cronjobs # Recreate the apim cron jobs
See code: src/commands/cron-jobs/recreate.js
(custom) Runs the provided nodejs script inside the apim pod
USAGE
$ apicops custom:run SCRIPT [PARAMS]
ARGUMENTS
SCRIPT The path to the script to execute inside the apim pod
PARAMS Any parameters to pass to the script. Separate multiple parameters by a space and enclose all parameters with
spaces in them with "s
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops runcustom
EXAMPLES
$ apicops custom:run /tmp/myscript.js # Run a script with no parameters
$ apicops custom:run /tmp/myscript.js one two # Run a script with 2 parameters
$ apicops runcustom /tmp/s.js one "param two" # Run a script with 2 parameters
See code: src/commands/custom/run.js
(getgrace) Gets the current value for the time between compaction of tombstones
USAGE
$ apicops grace-period:get
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops getgrace
EXAMPLES
$ apicops grace-period:get # Gets the current grace period
$ apicops getgrace # Gets the current grace period
See code: src/commands/grace-period/get.js
(setgrace) Sets the time between compaction of tombstones
USAGE
$ apicops grace-period:set PERIOD
ARGUMENTS
PERIOD (short|long) Set to "short" to cleanup tombstones every 2 mins, or "long", to cleanup every 3 days
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops setgrace
EXAMPLES
$ apicops grace-period:set long # Sets the current grace period to 3 days
$ apicops setgrace short # Sets the current grace period to 2 minutes
See code: src/commands/grace-period/set.js
display help for apicops
USAGE
$ apicops help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
(deletelocks) Deletes any expired transaction locks
USAGE
$ apicops locks:delete-expired
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops deletelocks
EXAMPLES
$ apicops locks:delete-expired # Deletes any expired transaction locks
$ apicops deletelocks # Deletes any expired transaction locks
See code: src/commands/locks/delete-expired.js
(fixoauth) Fix the shared OAuth secret for the given catalog and gateway service
USAGE
$ apicops oauth-secret:fix URL
ARGUMENTS
URL The catalog and gateway service, identified via name or UUID, in the form, <catalog>/<gateway service>, or
<org>/<catalog>/<gateway service>
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops fixoauth
EXAMPLES
$ apicops oauth-secret:fix unique-gateway-1 # Fixes the OAuth secret for the given gateway service
$ apicops fixoauth 5cec22d4-3c93-44ac-a4c0-750b4a57756c # Fixes the OAuth secret for the gateway identified by UUID
$ apicops fixoauth myorg/mycatalog/gateway-1 # Fixes the OAuth secret for the given gateway service
See code: src/commands/oauth-secret/fix.js
(org) Looks up a specific organisation based on uuid or name
USAGE
$ apicops organisations:get ORG
ARGUMENTS
ORG The id or name of the org
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops org
EXAMPLES
$ apicops org 4eab42d5-6ba8-4e68-ac87-44ff229db677 # Get an organisation by UUID
$ apicops organisations:get myuniqueorg # Get an organisation using the unique organisation name
$ apicops organisations:get org1 # Get all organisations named org1
See code: src/commands/organisations/get.js
(orgs) Lists all organisations
USAGE
$ apicops organisations:list
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops orgs
EXAMPLES
$ apicops organisations:list # List all organisations
$ apicops orgs # List all organisations
See code: src/commands/organisations/list.js
(configuredgateway) Looks up a specific configured gateway service based on uuid or name with an optional org/catalog/ in front of the name/uuid
USAGE
$ apicops services:get-configured-gateway GATEWAY
ARGUMENTS
GATEWAY The id or name of the configured gateway service
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops configuredgateway
EXAMPLES
$ apicops services:get-configured-gateway gateway-1 # Gets all the configured gateways
with name gateway-1
$ apicops configuredgateway myuniqueorg:cat:gateway-1 # Gets all the configured gateways
with name gateway-1 in catalog cat in organisation myuniqueorg
$ apicops configuredgateway cbd062ad-f04c-44cd-afae-dd6a9247309c/gateway-1 # Gets all the configured gateways
with name gateway-1 in catalog with the UUID specified
$ apicops services:get-configured-gateway 740caa86-0c4e-4531-a460-3fb70890726e # Gets the configured gateway with the
UUID specified
See code: src/commands/services/get-configured-gateway.js
(configuredportal) Looks up a specific configured portal service based on uuid or name with an optional org/catalog/ in front of the name/uuid
USAGE
$ apicops services:get-configured-portal PORTAL
ARGUMENTS
PORTAL The id or name of the configured portal service
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops configuredportal
EXAMPLES
$ apicops services:get-configured-portal portal-1 # Gets all the configured portals with
name portal-1
$ apicops configuredportal myuniqueorg:cat:portal-1 # Gets all the configured portals with
name portal-1 in catalog cat in organisation myuniqueorg
$ apicops configuredportal cbd062ad-f04c-44cd-afae-dd6a9247309c/portal-1 # Gets all the configured portals with
name portal-1 in catalog with the UUID specified
$ apicops services:get-configured-portal 740caa86-0c4e-4531-a460-3fb70890726e # Gets the configured portal with the
UUID specified
See code: src/commands/services/get-configured-portal.js
(gateway) Looks up a specific gateway service based on uuid or name
USAGE
$ apicops services:get-gateway GATEWAY
ARGUMENTS
GATEWAY The id or name of the gateway service
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops gateway
EXAMPLES
$ apicops services:get-gateway gateway-1 # Gets the gateway with name gateway-1
$ apicops gateway 740caa86-0c4e-4531-a460-3fb70890726e # Gets the gateway with the UUID specified
See code: src/commands/services/get-gateway.js
(iss) Identifies the state of any gateway and portal services and returns any associated task ids that are incomplete. Can output compact or beautified and text or JSON
USAGE
$ apicops services:identify-state
OPTIONS
-e, --embellish Output a table per service instead of single lines. In JSON mode beautify the JSON
-j, --json Output as raw JSON instead of lines/tables
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops iss
See code: src/commands/services/identify-state.js
(configuredgateways) Lists all configured gateway services
USAGE
$ apicops services:list-configured-gateway
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops configuredgateways
EXAMPLES
$ apicops services:list-configured-gateways # Lists all the configured gateways
$ apicops configuredgateways # Lists all the configured gateways
See code: src/commands/services/list-configured-gateway.js
(configuredportals) Lists all configured portal services
USAGE
$ apicops services:list-configured-portal
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops configuredportals
EXAMPLES
$ apicops services:list-configured-portals # Lists all the configured portals
$ apicops configuredportals # Lists all the configured portals
See code: src/commands/services/list-configured-portal.js
(gateways) Lists all gateway services
USAGE
$ apicops services:list-gateways
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops gateways
EXAMPLES
$ apicops services:list-gateways # Lists all the gateways
$ apicops gateways # Lists all the gateways
See code: src/commands/services/list-gateways.js
(buildsnapshot) Compact the event queue into an up to date snapshot. If a catalog is given then the snapshot is build at the catalog level. If a configured gateway is given then the snapshot is build for that gateway (FP7 and below)
USAGE
$ apicops snapshots:build URL
ARGUMENTS
URL The catalog or configured gateway service, identified via name in the form, <catalog>, or <org>/<catalog>, or
<org>/<catalog>/<gateway service>, or by UUID in the form: <catalog>, or <gateway>. To list the catalogs run the
catalogs command, to list the configured gateways, run the configuredgateways command
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops buildsnapshot
EXAMPLES
$ apicops snapshots:build gateway-1 # Builds a snapshot for the single configured gateway
with the name gateway-1
$ apicops buildsnapshot 740caa86-0c4e-4531-a460-3fb70890726e # Builds a snapshot for the catalog with the UUID
specified
$ apicops buildsnapshot cbd062ad-f04c-44cd-afae-dd6a9247309c # Builds a snapshot for the gateway with the UUID
specified
$ apicops snapshots:build myuniqueorg/sandbox # Builds a snapshot for the sandbox catalog of the
myuniqueorg organisation
$ apicops buildsnapshot myuniqueorg/sandbox/gateway-2 # Builds a snapshot for gateway-2 of the snapshot
catalog of the myuniqueorg organisation
See code: src/commands/snapshots/build.js
(checksnapshot) Identifies bad products in the snapshot payload that have references to invalid apis for the given org and catalog (FP7 and below)
USAGE
$ apicops snapshots:check-invalid-products URL
ARGUMENTS
URL The catalog, identified via name or UUID, in the form, <catalog>, or <org>/<catalog>
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops checksnapshot
EXAMPLES
$ apicops snapshots:check-invalid-products mycatalog # Checks if there are invalid products in catalog
mycatalog
$ apicops checksnapshot aa592e2f-68b1-4380-ad7c-ac86c932f1e6 # Checks if there are invalid products in identified
catalog
$ apicops checksnapshot myorg/mycatalog # Checks if there are invalid products in the catalog
mycatalog
See code: src/commands/snapshots/check-invalid-products.js
(checksnapshotgateway) Check bad references of the api in api_urls in the product payload of the snapshot for the first configured gateway service for the given catalog (FP7 and below)
USAGE
$ apicops snapshots:check-invalid-products-gateway URL
ARGUMENTS
URL The gateway(s), identified via gateway UUID, catalog name/uuid in the form, <uuid>, <orgId/catalogId>,
<orgName/catalogName>
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops checksnapshotgateway
EXAMPLES
$ apicops snapshots:check-invalid-products-gateway mycatalog # Checks if there are
invalid products in the gateways associated with catalog mycatalog
$ apicops checksnapshotgateway aa592e2f-68b1-4380-ad7c-ac86c932f1e6 # Checks if there are
invalid products in the gateways associated with identified catalog
$ apicops checksnapshotgateway myorg/mycatalog # Checks if there are
invalid products in the gateways associated with catalog mycatalog
$ apicops snapshots:check-invalid-products-gateway a0050e90-cf97-4989-961f-97cee80ad4c3 # Checks if there are
invalid products in the gateway specified
See code: src/commands/snapshots/check-invalid-products-gateway.js
(fixsnapshot) Fixes the bad references of the api in api_urls in the product payload of the snapshot for the the given catalog (FP7 and below)
USAGE
$ apicops snapshots:fix-invalid-products CATALOG
ARGUMENTS
CATALOG The catalog, identified via name or UUID, in the form, <catalog>, or <org>/<catalog>
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops fixsnapshot
EXAMPLES
$ apicops snapshots:fix-invalid-products mycatalog # Fixes the invalid products in catalog mycatalog
$ apicops fixsnapshot aa592e2f-68b1-4380-ad7c-ac86c932f1e6 # Fixes the invalid products in identified catalog
$ apicops fixsnapshot myorg/mycatalog # Fixes the invalid products in the catalog mycatalog
See code: src/commands/snapshots/fix-invalid-products.js
(fixsnapshotgateway) Fixes the bad references of the api in api_urls in the product payload of the snapshot for the first configured gateway service for the given catalog (FP7 and below)
USAGE
$ apicops snapshots:fix-invalid-products-gateway URL
ARGUMENTS
URL The gateway(s), identified via gateway UUID, catalog name/uuid in the form, <uuid>, <orgId/catalogId>,
<orgName/catalogName>
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops fixsnapshotgateway
EXAMPLES
$ apicops snapshots:fix-invalid-products-gateway mycatalog # Fixes the invalid
products in the gateways associated with catalog mycatalog
$ apicops fixsnapshotgateway aa592e2f-68b1-4380-ad7c-ac86c932f1e6 # Fixes the invalid
products in the gateways associated with the identified catalog
$ apicops fixsnapshotgateway myorg/mycatalog # Fixes the invalid
products in the gateways associated with catalog mycatalog
$ apicops snapshots:fix-invalid-products-gateway a0050e90-cf97-4989-961f-97cee80ad4c3 # Checks if there are
invalid products in the gateway specified
See code: src/commands/snapshots/fix-invalid-products-gateway.js
(sendsnapshot) Send a snapshot to the service identified by the UUID provided. Note that before sending the snapshot the entire task queue will be cleared, so if you have any tasks in 'new' or 'inprogress' state etc. then they should either be sorted out first, or you will have to run sendsnapshot for the catalog related to those tasks afterwards (FP7 and below)
USAGE
$ apicops snapshots:send SERVICE
ARGUMENTS
SERVICE The portal or gateway service UUID
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops sendsnapshot
EXAMPLES
$ apicops snapshots:send gateway-1 # Gets all the configured gateways with name gateway-1
$ apicops sendsnapshot 740caa86-0c4e-4531-a460-3fb70890726e # Builds a snapshot for the catalog with the UUID
specified
$ apicops sendsnapshot cbd062ad-f04c-44cd-afae-dd6a9247309c # Builds a snapshot for the gateway with the UUID
specified
$ apicops snapshots:send myuniqueorg/sandbox # Builds a snapshot for the sandbox catalog of the
myuniqueorg organisation
$ apicops sendsnapshot myuniqueorg/sandbox/gateway-2 # Builds a snapshot for gateway-2 of the snapshot catalog
of the myuniqueorg organisation
See code: src/commands/snapshots/send.js
(validatesnapshot) Validate the snapshots for a catalog, for the portal or the gateway, or both (FP7 and below)
USAGE
$ apicops snapshots:validate CATALOG
ARGUMENTS
CATALOG The catalog, identified via name or UUID, in the form, <catalog>, or <org>/<catalog>
OPTIONS
-g, --gateway Validate the gateway snapshots for the catalog
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
-p, --portal Validate the portal snapshots for the catalog
ALIASES
$ apicops validatesnapshot
EXAMPLES
$ apicops snapshots:validate -p myuniquecatalog # Validates the portal snapshot for the catalog
myuniquecatalog
$ apicops snapshots:validate -pg myuniquecatalog # Validates the portal and gateway snapshots for
the catalog myuniquecatalog
$ apicops snapshots:validate -g myuniquecatalog # Validates the gateway snapshot for the catalog
myuniquecatalog
$ apicops validatesnapshot -g 740caa86-0c4e-4531-a460-3fb70890726e # Validates the gateway snapshot for the catalog
identified by the UUID
See code: src/commands/snapshots/validate.js
(sp) Looks up a specific space based on the uuid of the space or name of the space in the format <org_id_or_name>/<catalog_id_or_name>/<space_id_or_name>
USAGE
$ apicops spaces:get SPACE
ARGUMENTS
SPACE The id of the space, or, the name of the space in a particular org and catalog (format
<org_id_or_name>/<catalog_id_or_name>/<space_id_or_name>)
OPTIONS
-c, --catalogId=catalogId [default: ""] The id of the catalog you want to list the spaces within
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops sp
EXAMPLES
$ apicops sp 4eab42d5-6ba8-4e68-ac87-44ff229db677 # Get a space by UUID
$ apicops spaces:get myuniquespace # Get a space using the unique space name
$ apicops spaces:get org1/cat1/space-1 # Get a space by URL
$ apicops spaces:get space-1 # Get all spaces named space-1
$ apicops spaces:get -c cat1 space-1 # Get a space named space-1 in catalog cat-1
$ apicops sp --catalogId 745c9bab-e0ba-4d34-a284-aa3a28f77a7b space-1 # Get a space named space-1 in the catalog
identified by the UUID
See code: src/commands/spaces/get.js
(sps) Lists all spaces
USAGE
$ apicops spaces:list
OPTIONS
-c, --catalogId=catalogId [default: ""] The id or name of the catalog you want to list the spaces within
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops sps
EXAMPLES
$ apicops sps # List all spaces
$ apicops spaces:list # List all spaces
$ apicops spaces:list -c cat1 # List all spaces in catalog cat1
$ apicops sps --catalogId 745c9bab-e0ba-4d34-a284-aa3a28f77a7b # List all spaces in the catalog identified by the
UUID
See code: src/commands/spaces/list.js
(clearsubqueue) Clears all subscriber queue (FP7 and below)
USAGE
$ apicops subscriber-queues:clear
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops clearsubqueues
EXAMPLES
$ apicops subscriber-queues:clear # Clears all items from the subscriber queues
$ apicops clearsubqueues # Clears all items from the subscriber queues
See code: src/commands/subscriber-queues/clear.js
(subqueuelength) Shows the length of the subscriber queue specified
USAGE
$ apicops subscriber-queues:get-length SUBSCRIBER
ARGUMENTS
SUBSCRIBER The id or name of the configured gateway service or portal service. If not unique you can prefix it with
org/catalog or just catalog, where org and catalog can be names or uuids
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops subqueuelength
EXAMPLES
$ apicops subscriber-queues:get-length myuniquecatalog/portal-1 # Gets the length of the portal-1 subscriber queue
$ apicops subqueuelength aa592e2f-68b1-4380-ad7c-ac86c932f1e6 # Gets the length of the subscriber queue for the
portal service specified by the UUID
$ apicops subqueuelength cbd062ad-f04c-44cd-afae-dd6a9247309c # Gets the length of the subscriber queue for the
gateway service specified by the UUID
$ apicops subscriber-queues:get-length unique-portal-1 # Gets the length of the unqiue-portal-1 subscriber
queue
See code: src/commands/subscriber-queues/get-length.js
(checkdataindexes) Checks inconsistencies between the main and index tables (data available in main table and not present in index table. Similarly data present in index table but not in main table)
USAGE
$ apicops tables:check-index
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops checktablesindex
EXAMPLES
$ apicops tables:check-index # Checks the index tables for inconsistencies
$ apicops checktablesindex # Checks the index tables for inconsistencies
See code: src/commands/tables/check-index.js
(checkdatalinks) Checks inconsistencies between the link tables and the corresponding index tables
USAGE
$ apicops tables:check-link
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops checktableslink
EXAMPLES
$ apicops tables:check-link # Checks the link tables for inconsistencies
$ apicops checktableslink # Checks the link tables for inconsistencies
See code: src/commands/tables/check-link.js
(tablecontents) Dump out the contents in JSON format for the table specified. If the table is not provided you will be prompted from a list of available tables.
USAGE
$ apicops tables:get-contents [TABLE] [CHUNKSIZE]
ARGUMENTS
TABLE The table to list the contens of
CHUNKSIZE [default: 65536] The chunk size to use for the select operation. If the objects in the table are very large
then a smaller chink size should be used.
OPTIONS
-e, --embellish Beautify the JSON
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops tablecontents
EXAMPLES
$ apicops tables:get-contents apim.webhook # Get the contents of the apim.webhook table
$ apicops tablecontents lur.dbuser # Get the contents of the lur.dbuser table
$ apicops tablecontents lur.dbuser 64 # Get the contents of the lur.dbuser table with a chunk size of 64
$ apicops tablecontents -e lur.dbuser 64 # Get the contents of the lur.dbuser table with a chunk size of 64 and
beautify the JSON
See code: src/commands/tables/get-contents.js
(tablesizes) List the sizes of all tables in the key space given. If no key space is provided you will be prompted from a list of available key spaces.
USAGE
$ apicops tables:list-sizes [KEYSPACE]
ARGUMENTS
KEYSPACE (apim|system|system_auth|lur|system_distributed|system_schema) The keyspace in which to list the table sizes
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops tablesizes
EXAMPLES
$ apicops tables:list-sizes apim # List the sizes of all tables in the apim key space
$ apicops tablesizes lur # List the sizes of all tables in the lur key space
See code: src/commands/tables/list-sizes.js
(rebuildindexes) Truncates and repopulates the index tables from the associated main table provided. If no table is provided you will be prompted from a list of available tables
USAGE
$ apicops tables:rebuild-indexes [TABLE]
ARGUMENTS
TABLE The name of the main table to rebuild the associated index tables from
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops rebuildindexes
EXAMPLES
$ apicops rebuildindexes apim.my_task # Rebuild the index tables associated with and based off the content of the
apim.my_task main table
$ apicops tables:rebuild-indexes # Will prompt for the main table you want to choose from a list before
rebuilding the index tables based on the table chosen
See code: src/commands/tables/rebuild-indexes.js
(cleartasks) Clear the task queue of all tasks (FP7 and below)
USAGE
$ apicops task-queue:clear
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops cleartasks
EXAMPLES
$ apicops task-queue:clear # Clears all tasks from task queue
$ apicops cleartasks # Clears all tasks from task queue
See code: src/commands/task-queue/clear.js
(creategatewaytask) Creates a snapshot task for the specified gateway (FP7 and below)
USAGE
$ apicops tasks:create-gateway GATEWAY
ARGUMENTS
GATEWAY The configured gateway service ID or URL
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops creategatewaytask
EXAMPLES
$ apicops creategatewaytask 4eab42d5-6ba8-4e68-ac87-44ff229db677 # Creates a snapshot task for the gateway specified
by the UUID
$ apicops tasks:create-gateway org/cat/gateway-1 # Creates a snapshot task for the gateway specified
by the url
$ apicops tasks:create-gateway unique-cat:gateway-1 # Creates a snapshot task for the gateway specified
by the url
See code: src/commands/tasks/create-gateway.js
(createportaltask) Creates a snapshot task for the specified portal (FP7 and below)
USAGE
$ apicops tasks:create-portal PORTAL
ARGUMENTS
PORTAL The configured portal service ID or URL
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops createportaltask
EXAMPLES
$ apicops createportaltask 4eab42d5-6ba8-4e68-ac87-44ff229db677 # Creates a snapshot task for the portal specified by
the UUID
$ apicops tasks:create-portal org/cat/portal-1 # Creates a snapshot task for the portal specified by
the url
$ apicops tasks:create-portal unique-cat:portal-1 # Creates a snapshot task for the portal specified by
the url
See code: src/commands/tasks/create-portal.js
(gettask) Dumps out the task identified by taskId
USAGE
$ apicops tasks:get TASKID
ARGUMENTS
TASKID The id of the task to show
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops gettask
EXAMPLES
$ apicops gettask 4eab42d5-6ba8-4e68-ac87-44ff229db677 # Get a task by UUID
$ apicops tasks:get 4eab42d5-6ba8-4e68-ac87-44ff229db677 # Get a task by UUID
See code: src/commands/tasks/get.js
( Lists all tasks )
USAGE
$ apicops tasks:list
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
EXAMPLE
$ apicops tasks:list # List all tasks
See code: src/commands/tasks/list.js
(renewtask) Re-triggers the provided task id by setting its state to 'new' so that it gets picked up for processing again
USAGE
$ apicops tasks:renew TASKID
ARGUMENTS
TASKID The id of the task to renew
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops renewtask
EXAMPLES
$ apicops renewtask 4eab42d5-6ba8-4e68-ac87-44ff229db677 # Renews a task by UUID
$ apicops tasks:renew 4eab42d5-6ba8-4e68-ac87-44ff229db677 # Renews a task by UUID
See code: src/commands/tasks/renew.js
(checkorphans) Lists any orphaned webhook subscriptions
USAGE
$ apicops webhook-subscriptions:check-orphans
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops checkorphans
EXAMPLES
$ apicops webhook-subscriptions:check-orphans # List any orphaned webhook subscriptions
$ apicops checkorphans # List any orphaned webhook subscriptions
See code: src/commands/webhook-subscriptions/check-orphans.js
(deleteorphans) Deletes any orphaned webhook subscriptions
USAGE
$ apicops webhook-subscriptions:delete-orphans
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops deleteorphans
EXAMPLES
$ apicops webhook-subscriptions:delete-orphans # Deletes any orphaned webhook subscriptions
$ apicops deleteorphans # Deletes any orphaned webhook subscriptions
See code: src/commands/webhook-subscriptions/delete-orphans.js
(webhooksubscriptions) Lists all webhook subscriptions
USAGE
$ apicops webhook-subscriptions:list
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops webhooksubs
EXAMPLES
$ apicops webhook-subscriptions:list # List all webhook subscriptions
$ apicops webhooksubs # List all webhook subscriptions
See code: src/commands/webhook-subscriptions/list.js
(markgatewaysub) Update the state of the given gateway webhook subscription record to online (FP7 and below)
USAGE
$ apicops webhook-subscriptions:mark-gateway URLORID
ARGUMENTS
URLORID The "Webhook URL" of the gateway or just the uuid for the configured gateway service from "apicops iss"
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops markgatewaysub
EXAMPLES
$ apicops markgatewaysub 843d3499-da6b-4acd-a265-3753d7a71668 # Update the subcsription to online for the gateway
identified by UUID
$ apicops webhook-subscriptions:mark-gateway org/cat/gateway-1 # Update the subcsription to online for the gateway
identified by the URL
$ apicops markgatewaysub myuniquecat:gateway-1 # Update the subcsription to online for the gateway
identified by the URL
See code: src/commands/webhook-subscriptions/mark-gateway.js
(markportalsub) Update the state of the given portal webhook subscription record to offline_configured (FP7 and below)
USAGE
$ apicops webhook-subscriptions:mark-portal URLORID
ARGUMENTS
URLORID The "Webhook URL" of the portal or just the uuid for the configured portal service from "apicops iss"
OPTIONS
-n, --namespace=namespace The kubernetes namespace to target (this will override any namespace you may have set in
your kubeconfig)
ALIASES
$ apicops markportalsub
EXAMPLES
$ apicops markportalsub 843d3499-da6b-4acd-a265-3753d7a71668 # Update the subcsription to offline_configured for the
portal identified by UUID
$ apicops webhook-subscriptions:mark-portal org/cat/portal-1 # Update the subcsription to offline_configured for the
portal identified by the URL
$ apicops markportalsub myuniquecat:portal-1 # Update the subcsription to offline_configured for the
portal identified by the URL