Use the 3scale toolbox to create, apply, list, show, or delete services in your Developer Portal.
2.11.1. Creating a new service
The following command creates a new service:
Use the following options while creating services:
Options
-a --authentication-mode=<value> Specify authentication mode of the service ('1' for API key, '2' for
App Id / App Key, 'oauth' for OAuth mode, 'oidc' for OpenID Connect)
-d --deployment-mode=<value> Specify the deployment mode of the service
--description=<value> Specify the description of the service
-s --system-name=<value> Specify the system-name of the service
--support-email=<value> Specify the support email of the service
Options for service
-c --config-file=<value> 3scale toolbox configuration file (default:
$HOME/.3scalerc.yaml) -h --help show help for this command
-k --insecure Proceed and operate even for server 3scale method delete [opts] <remote> <service> <metric>
3scale service create [options] <remote> <service-name>
connections otherwise considered insecure
-v --version Prints the version of this command --verbose Verbose mode
2.11.2. Creating or updating services
Use the following to create new services if they do not exist, or to update an existing one:
NOTE
service-id_or_system-name positional argument is a service reference.
It can be either service id, or service system_name.
Toolbox will automatically figure this out.
This command is idempotent.
The following command updates services:
Use the following options while updating services:
Options
-a --authentication-mode=<value> Specify authentication mode of the service ('1' for API key, '2' for
App Id / App Key, 'oauth' for OAuth mode, 'oidc' for OpenID Connect)
-d --deployment-mode=<value> Specify the deployment mode of the service
--description=<value> Specify the description of the service
-n --name=<value> Specify the name of the metric --support-email=<value> Specify the support email of the service
Options for services
-c --config-file=<value> 3scale toolbox configuration file (default: $HOME/.3scalerc.yaml) -h --help show help for this command
-k --insecure Proceed and operate even for server connections otherwise considered
insecure
-v --version Prints the version of this command --verbose Verbose mode
2.11.3. Listing services
The following command lists services:
3scale service apply <remote> <service-id_or_system-name>
3scale service list <remote>
Use the following options while listing services:
Options for services
-c --config-file=<value> 3scale toolbox configuration file (default:
$HOME/.3scalerc.yaml) -h --help show help for this command
-k --insecure Proceed and operate even for server connections otherwise considered insecure -v --version Prints the version of this command --verbose Verbose mode
2.11.4. Showing services
The following command shows services:
Use the following options while showing services:
Options for services
-c --config-file=<value> 3scale toolbox configuration file (default: $HOME/.3scalerc.yaml) -h --help show help for this command
-k --insecure Proceed and operate even for server connections otherwise considered insecure -v --version Prints the version of this command --verbose Verbose mode
2.11.5. Deleting services
The following command deletes services:
Use the following options while deleting services:
Options for services
-c --config-file=<value> 3scale toolbox configuration file (default:
$HOME/.3scalerc.yaml) -h --help show help for this command
-k --insecure Proceed and operate even for server connections otherwise considered insecure -v --version Prints the version of this command --verbose Verbose mode
2.12. ACTIVEDOCS
Use the 3scale toolbox to create, update, list, or delete ActiveDocs in your Developer Portal.
2.12.1. Creating new ActiveDocs
To create a new ActiveDocs from your OpenAPI / Swagger compliant API defintion:
3scale service show <remote> <service-id_or_system-name>
3scale service delete <remote> <service-id_or_system-name>
1. Add your API defintion to 3scale, optionally giving it a name:
Use the following options while creating ActiveDocs:
Options
2. Publish the definition in your Developer Portal.
2.12.2. Creating or updating ActiveDocs
Use the following command to create new ActiveDoc if they do not exist, or to update existing ActiveDocs with a new API definition:
Use the following options while updating ActiveDocs:
Options
3scale activedocs create <remote> <activedocs-name> <spec>
3scale activedocs apply <remote> <activedocs_id_or_system_name>
will be hidden
-s --name=<value> Specify the name of the ActiveDocs --skip-swagger-validations Specify it to skip validation of the Swagger specification
Options for ActiveDocs
-c --config-file=<value> 3scale toolbox configuration file (default: $HOME/.3scalerc.yaml) -h --help show help for this command
-k --insecure Proceed and operate even for server connections otherwise considered insecure
-v --version Prints the version of this command --verbose Verbose mode
2.12.3. Listing ActiveDocs
Use the following command to get information about all ActiveDocs in the developer portal, including:
id name
system name description
published (which means it can be shown in the developer portal) creation date
latest updated date
The following command lists all defined ActiveDocs:
Use the following options while listing ActiveDocs:
Options for ActiveDocs
-c --config-file=<value> 3scale toolbox configuration file (default: $HOME/.3scalerc.yaml) -h --help show help for this command
-k --insecure Proceed and operate even for server connections otherwise considered insecure -v --version Prints the version of this command --verbose Verbose mode
2.12.4. Deleting ActiveDocs
The following command removes ActiveDocs:
3scale activedocs list <remote>
3scale activedocs delete <remote> <activedocs-id_or-system-name>
Use the following options while deleting ActiveDocs:
Options for ActiveDocs
-c --config-file=<value> 3scale toolbox configuration file (default: $HOME/.3scalerc.yaml) -h --help show help for this command
-k --insecure Proceed and operate even for server connections otherwise considered insecure -v --version Prints the version of this command --verbose Verbose mode