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):
```
apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm
```
For example,
```
apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm 
total_results: 2
results:
  - title: API Manager User Registry
    realm: provider/default-idp-2
  - title: Corporate LDAP user registry
    realm: provider/corporate-ldap
```
The title value should enable you to determine which identity provider to use; you can then copy the corresponding --realm parameter directly from the displayed realm value. For any identity providers that your administrator created after API Connect was installed, the names are determined at creation time. The default API Manager Local User Registry for login as a member of a provider organization is default-idp-2.
For full details of the apic login command, see Logging in to a management server.

For a summary of the general-purpose commands and their use, see Developer Portal CLI commands.
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 be json, yaml, go-template=..., go-template-file=.... Defaults to yaml.
Get an API from a site by using the id or name: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 or example:3.0.0.

Get a specific entire API document from the portal of the provided organization and catalog by using the id or name:version.

apic --mode portaladmin api:get-document --org orgid/name --server management_server --catalog catalogid/name --format format_type  id/name:version

For example,

apic --mode portaladmin api:get-document --org ibm --server management_server --catalog portal-test --format yaml  intuiz-api:1.0.0

Add an attachment for your API within your Developer Portal.

For example,

apic --mode portaladmin api:add-attachment -s management_server --org orgid/name --catalog catalogid/name --attachment_name attachment.txt --attachment_description "API documentation" mortgage-management-api:1.0.0 ./attachment.txt
Loading File (Large files may take a while)...

Attachment successfully added to api mortgage-management-api:1.0.0.
  This product now has 4 attachments.

attachment_name is the name given to the attachment when it is uploaded (required).
attachment_description is the description of the attachment that is displayed to the users.

Set an icon for your API within your Developer Portal.

For example,

apic --mode portaladmin api:set-icon -s management_server --org orgid/name --catalog catalogid/name --icon_description "API icon" mortgage-management-api:1.0.0 ./icon.png
Loading File (Large files may take a while)...

Icon successfully set for api mortgage-management-api:1.0.0

icon_description is the icon description to be displayed to users and it is used as an alt text for the image (required).

Add a tag (Category) for your API within your Developer Portal.

For example,

apic --mode portaladmin api:add-tag -s management_server --org orgid/name --catalog catalogid/name --tag_name top_level_element/next_level_element/lower_level_element mortgage-management-api:1.0.0
Successfully set taxonomy tag top_level_element/next_level_element/lower_level_element
  for api mortgage-management-api:1.0.0

tag_name is the tag name. For example, top_level_element/next_level_element (required).