Using the api commands
You can use the api commands to get and list the APIs on your Developer Portal service.
- Log in as Provider org:
apic login --server management_server --realm provider/identity_provider --username provider_username --password provider_password
You can determine which identity provider to use in the--realm
parameter by entering the following command to see a list of all available identity providers (you do not need to be logged in to use this command):
For example:apic identity-providers:list --scope provider --server mgmt_endpoint_url --fields title,realm
Theapic identity-providers:list --scope provider --server myserver.com --fields title,realm total_results: 2 results: - title: Cloud Manager User Registry realm: provider/default-idp-2 - title: Corporate LDAP user registry realm: provider/corporate-ldap
title
value should enable you to determine which identity provider to use; you can then copy the corresponding--realm
parameter directly from the displayedrealm
value. For any identity providers that were created by your administrator after API Connect was installed, the names will have been determined at creation time. The default API Manager Local User Registry for login as a member of a provider organization isdefault-idp-2
.For full details of the
apic login
command, see Logging in to a management server. - List the APIs from a site. For example,
apic --mode portaladmin api:list --org orgid/name --server management_server --catalog catalogid/name
management_server
is the endpoint URL of the management server (required).catalogid/name
is the ID or name of the catalog that the site belongs to (required).orgid/name
is the ID or name of the provider organization that the catalog belongs to (required).format_type
is the output format. Can bejson
,yaml
,go-template=...
,go-template-file=...
. Defaults toyaml
.
- Get an API from a site by using the
id
orname:version
.For example,apic --mode portaladmin api:get --org orgid/name --server management_server --catalog catalogid/name id/name:version
id/name:version
- The ID or name:version of a specific API (required). For example,id-of-api-called-example-3
orexample:3.0.0
.
- Get a specific entire API document from the portal of the provided
organization and catalog by using the
id
orname:version
.
For example:apic --mode portaladmin api:get-document --org orgid/name --server management_server --catalog catalogid/name --format format_type id/name:version
apic --mode portaladmin api:get-document --org ibm --server my.management.server.com --catalog portal-test --format yaml intuiz-api:1.0.0