IBM API Connect CLI

https://ibm-apiconnect.github.io/clidocs
Admin
IBM API Connect CLI is a command-line toolkit for managing APIs and developer portals across...
Tokens:265,781
Snippets:1,232
Trust Score:8.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### APIConnect CLI Examples

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/discovery/apic

Illustrative examples of how to use the APIConnect CLI. These examples demonstrate accepting licenses, controlling live help, and setting the language.

```bash
apic --accept-license --live-help=false
```

```bash
apic --accept-license --live-help=true
```

```bash
apic --lang [en-us|cs|de|es|fr|it|ja|ko|nl|pl|pt-br|ru|tr|zh-cn|zh-tw]
```

--------------------------------

### Get Role Command Usage Example

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/portaladmin/role/apic_role_get

This snippet illustrates a common usage pattern for the 'apic role:get' command, including specifying the role name. It demonstrates how to fetch a specific role and its associated permissions.

```bash
apic role:get --mode portaladmin [flags] ROLE
```

--------------------------------

### apic apis:get Usages with Name:Version and Scope

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/apis/apic_apis_get

Illustrates using 'apic apis:get' to fetch APIs by their name and version, specifying either a space or catalog scope.

```bash
apic apis:get [flags] --scope space NAME:VERSION
apic apis:get [flags] --scope catalog NAME:VERSION
```

--------------------------------

### Subscription Configuration File Example

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/subscriptions/apic_subscriptions_create

An example YAML configuration file required to define the subscription properties. It includes mandatory fields like 'plan' and 'product_url'.

```yaml
name: acme-subscription
plan: acme-plan
product_url: https://acme-apim.example.com/api/spaces/acme-org/acme-catalog/acme-space/products/acme-product
summary: An example subscription create
title: ACME Subscription
```

--------------------------------

### Draft product configuration example

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/draft-products/apic_draft-products_publish

An example of the YAML configuration structure for a draft product, including visibility settings for subscription and viewing.

```yaml
draft_product_url: https://api.acme-apim.example.com/api/orgs/acme-org/drafts/draft-products/draft-product-id
visibility:
  subscribe:
    enabled: true
    orgs: []
    tags: []
    type: authenticated
  view:
    enabled: true
    orgs: []
    tags: []
    type: public
```

--------------------------------

### API Connect CLI Command Options

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/simple-aliases/apic_simple-aliases_get

Standard configuration flags for the simple-aliases:get command, including output formatting and scope definitions.

```bash
apic simple-aliases:get -c CATALOG_ID -o ORG_ID -s SERVER_URL --space SPACE_ID --format json
```

--------------------------------

### APIConnect CLI Examples

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/governance/apic

Illustrates common use cases for the APIConnect CLI, such as accepting the license, enabling/disabling live help, and setting the operational language. These examples provide practical guidance for users.

```bash
# To accept the license and disable live-help, you can run the following command:
apic --accept-license --live-help=false  

# To accept the license and enable live-help, you can run the following command:
apic --accept-license --live-help=true  

# To set the language, you can run the following command:
apic --lang [en-us|cs|de|es|fr|it|ja|ko|nl|pl|pt-br|ru|tr|zh-cn|zh-tw]  

```

--------------------------------

### Truststore configuration example

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/truststores/apic_truststores_create

An example YAML configuration for a truststore, including metadata and the PEM-encoded certificate content.

```yaml
name: acme-truststore
summary: An example truststore create
title: ACME Truststore
truststore: |
  -----BEGIN CERTIFICATE-----
  MIIC2jCCAkMCAg38MA0HCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMaWg
  A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNere
  MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVbamTD0ZyYW5rNEREIFdl
  YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazrKzC5jb20wHhcNMTIw
  ODIyMDUyNzQxWhcNMTcwODIxMDUyNzQxWjBKMQswCQYdvqQGEwJKUDEOMAwGA1UE
  CAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA94e4cuZXhhbxBs
  ZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC0z9FeMynsC8+u
  dvX+LciZxnh5uRj4C9S6tNeeAlIGCfQYk0zUcNFCoCkTknNQd/YEiawDLNbxBqut
  bMDZ1aarys1a0lYmUeVLCIqvzBkPJTSQsCopQQ9V8WuT252zzNzs68dVGNdCJd5J
  NRQykpwexmnlOOv0mvj7i8XgG379TyW6P+WWV5okeUkXJ9eJS2ouDYdR2SM9BoVW
  +FgxDu6BmXhozW5EfsnajFp7HL8kQClI0QOc79yuKl3492rH6bzFsFn2lfwWy9ic
  7cP8EpCTeFp1tFaD+vxBhPZkeTQ1HKx6hQ5zeHIB5ySJJZ7af2W8r4eTGYzbdRW2
  4DDHCPhZAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAQMv+BFvGdMVzkQaQ3/+2noVz
  /uAKbzpEL8xTcxYyP3lkOeh4FoxiSWqy5pGFALdPONoDuYFpLhjJSZaEwuvjI/Tr
  rGhLV1pRG9frwDFshqD2Vaj4ENBCBh6UpeBop5+285zQ4SI7q4U9oSebUDJiuOx6
  +tZ9KynmrbJpTSi0+BM=
  -----END CERTIFICATE-----
```

--------------------------------

### Mail Server Configuration Examples

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/mail-servers/apic_mail-servers_test-connection

YAML configuration structures for testing mail server connections. The first example defines full server credentials and recipients, while the second example defines recipients for an existing server connection.

```yaml
mail_server:
  credentials:
    password: Passw0rd
    username: Acme
  host: acme.example.com
  name: acme-mail-server
  port: 25
  secure: true
  title: Acme mail server test connection
recipients:
- acme@example.com
```

```yaml
recipients:
- acme@example.com
```

--------------------------------

### Gateway Service Configuration Examples

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/gateway-services/apic_gateway-services_create

YAML configuration examples for defining Gateway Services, including settings for LDAP connection pools and v5 gateway communication parameters.

```yaml
api_endpoint_base: https://gw.acme-apim.example.com
endpoint: https://gw.acme-apim.example.com
gateway_service_type: datapower-api-gateway
ldap_cxn_pool:
  document_cache_size: 0
  enabled: true
  idle_timeout: 100
  max_pool_size: 30
name: acme-api-gateway-service
sni:
- host: '*'
  tls_server_profile_url: https://acme-apim.example.com/api/orgs/tls-server-profiles
title: ACME API Gateway Service
```

```yaml
api_endpoint_base: https://gw.acme-apim.example.com
communication_kind: external
communication_to_analytics_with_jwt: true
endpoint: https://gw.acme-apim.example.com
gateway_service_type: datapower-gateway
name: acme-v5-gateway-service
sni:
- host: '*'
  tls_server_profile_url: https://acme-apim.example.com/api/orgs/tls-server-profiles
title: ACME v5 Gateway Service
```

--------------------------------

### Configured Catalog User Registry Definition Example

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/configured-catalog-user-registries/apic_configured-catalog-user-registries_create

An example of the content required within the configuration file to define the user registry URL.

```yaml
user_registry_url: https://acme-apim.example.com/api/user-registries/acme-org/acme-user-regsitry
```

--------------------------------

### Space Settings Configuration Example

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/space-settings/apic_space-settings_update

An example of the YAML structure required for the SPACE_SETTING_FILE. This defines properties such as product visibility, notification templates, and email sender details.

```yaml
allowed_product_visibility:
  subscribe:
    enabled: false
    type: authenticated
  view:
    enabled: false
    type: public
custom_notification_templates_enabled: true
email_sender:
  address: acme-mail@example.com
  custom: true
  name: ACME Mail
invitation_ttl: 172800
subscription_task_approval_retention: 60
```

--------------------------------

### JWK set configuration file example

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/jwk-sets/apic_jwk-sets_create

An example of the YAML structure required for the JWK_SET_FILE. It includes a list of keys with their respective RSA parameters and a title for the set.

```yaml
keys:  
- d: CFpObmn1kAgkgfIlLMyFPGWobo2npm675YgXyy-ybhryvi1R7PoYA1y9m9geQoJJNC71hpDbvMQRMSF4NLvE9Hdbl6s-nr4zITklhwzwdr07Hb1p2lnJ_fsGFQNFVnGL--zDFvbZKAh0LdjSqCVG7PvV1baSg2IFLWIUcuPHO4L5RPueeSIXmDbLMZOt4hjetdn4B6zoiXfdaNOHrjfe-uZOVzywqjs7UdwlKiwgQ9eZACRkatnCBaPJGHheNjd6g9pT3HZxA6zmA_CZ3AGdneEg2g6pBWS94mMFQrgkFvjnrZHn9jO7FobVMrqaBWufBSPnAR86vSu3Hep-KBngUw  
  dp: KORZ7ehBCifmLvlxA9qR7n7Wuzitu8-SwMCUiQgAq8fcTQnpSQY3pAfa-QrrttimXQooEeu5zszsC8kldAwTfKNB_f3SGBSx24Xqya0Xf6STYXldgc2Y34nPF4kyCaAplE06aiB-lAtqcTcmTRrFHjVBjAuHzpfKN6J3chkF9o0  
  dq: iH_pnBEQ32A7ctv8BcSCtuwA9ePuczPngE_jhxptZM5jiCADp-E9upWFtZT3SZeAiD37MjWsTUaAwW3Uowus8CDchTN09cPSjFQffYAgL39NV_5jmIQ4aDPuDkPn94av6jzi3vOUzndrz2Xqp6MeOc64XpEQhyhcKAd1uIT1EPc  
  e: AQAB  
  kid: b449971a-2d70-4a60-8171-8f84d71536a3  
  kty: RSA  
  "n": s6-7fcj1M4c1fjoo1ZSyDfCxJ6C54jOJ3_u95CSa77AS6t8cTSRXrriyh9rd-mpxZaYlhZlsfoi286k5c8AcQRDv6Qu_IIv8FgoQEQNyTAWzspFsVoWNyF923V3vFfbgZuqdiOxODgAaEyjBWjOZ1yQTdQwT09g3aQSmS2UOsBGOI8mIPlnK_tZ6p4SxIC2kg_K8WeIoA8taT9CNfrOPHgJhG6kgcg5YOlpu9By5AqvZVALNPK4lAThwOfvrDG92MVekDRqGG4hUNaO4JhnV8eJz2cp1Qc3pKSJsDdubRY_mH6bd6FfG6LsAhkEvsmQYIE0T24pcZyti4mRf9-mqmQ  
  p: 9nQtcWJt89_NT2xXg5ebo-uYFdVdGSCAdHjZkdWR0QWa4g8fMTEgBgPWZe-h3zzQoBm8AuoZZB6T9QKea9w0YAX-nesAkA0KgUoeaD4t-NhI12Il1irpAJTBdLreltE54M1Ca-SE4s6qpm9kJ8PIprxtdKeGMc5kRu0A0FBsGL8  
  q: uqV-TdYImgwN4eISix7hV_f3VgEEQ1VfaV-65oGMh3PZCzV1kLm75fk32_NFaY1mLokbQeDJ3yUgiHi-iYRfKItS_22pZ1zGCEsN1k3lFr7ePrcgmjYMK2pUTpyxEc5Knzn5be4rb2dAvBsqccReps_RUxG2SA7YT7Xk9mqF-qc  
  qi: ns5ITFsJs9uKCJTeeUrbplxK9CB3NKqJAQP7JIHaqHf0Ryz1SrUKCDpu3N-FlYMOQ8U_rtmNTAngy6s3SQ15GaOnwlI1e2howNAF0G0zo4o2flxLlSUtnxsKSvM3-K6JyX6bw2S6aZkS0Y04U6RH1xPDWTRCd09MKYjD5AGjgvg  
- e: AQAB  
  kid: b449971a-2d70-4a60-8171-8f84d71536a3  
  kty: RSA  
  "n": s6-7fcj1M4c1fjoo1ZSyDfCxJ6C54jOJ3_u95CSa77AS6t8cTSRXrriyh9rd-mpxZaYlhZlsfoi286k5c8AcQRDv6Qu_IIv8FgoQEQNyTAWzspFsVoWNyF923V3vFfbgZuqdiOxODgAaEyjBWjOZ1yQTdQwT09g3aQSmS2UOsBGOI8mIPlnK_tZ6p4SxIC2kg_K8WeIoA8taT9CNfrOPHgJhG6kgcg5YOlpu9By5AqvZVALNPK4lAThwOfvrDG92MVekDRqGG4hUNaO4JhnV8eJz2cp1Qc3pKSJsDdubRY_mH6bd6FfG6LsAhkEvsmQYIE0T24pcZyti4mRf9-mqmQ  
title: acme-jwkset
```

--------------------------------

### Example engagement rule configuration

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/engagement/rules/apic_rules_catalogCreate

A YAML-formatted configuration file example defining an engagement rule. This file specifies data sources, metrics, scheduling, and notification triggers.

```yaml
data_source: apievents
enabled: true
filters:
- not:
    bytes_sent: 0
group_by: api_name
metric:
  avg:
    field: time_to_serve_request
schedule:
  period_interval: 1
  period_unit: MINUTES
  schedule_type: interval
timeframe: string
title: Large Payload
triggers:
- actions:
  - bcc: ""
    cc: ""
    destination_id: 858c9f23-af13-4408-845d-4e2eec321959
    id: 9291caef-fdd2-4774-a927-a4f5e75d016a
    message: API average latency greater than 2s
    subject: Slow APIs
    throttle:
      unit: MINUTES
      value: 1
    throttle_enabled: true
    title: string
    to: sre@example.com
  condition:
    operator: gt
    value: 2000
  severity: 1
  title: Greater than 2000
type: per_query
```

--------------------------------

### Availability Zone Definition Example

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/availability-zones/apic_availability-zones_create

An example of the YAML content required within the availability zone definition file. It defines the name, summary, and title for the new zone.

```yaml
name: acme-zone
summary: An example availability zone
title: acme zone
```

--------------------------------

### apic webhooks:get Command Usages with Scope

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/webhooks/apic_webhooks_get

These examples demonstrate how to use the 'apic webhooks:get' command with the '--scope' flag to specify whether to retrieve webhooks for a 'cloud' or a 'catalog'. The 'WEBHOOK' argument likely refers to a specific webhook identifier or type.

```bash
apic webhooks:get [flags] --scope cloud WEBHOOK
apic webhooks:get [flags] --scope catalog WEBHOOK
```

--------------------------------

### APIConnect CLI Examples

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/engagement/apic

Illustrates common usage patterns for the APIConnect CLI, such as accepting the license and configuring live help, as well as setting the operational language.

```bash
# Accept license and disable live-help
apic --accept-license --live-help=false

# Accept license and enable live-help
apic --accept-license --live-help=true

# Set the toolkit operation language
apic --lang [en-us|cs|de|es|fr|it|ja|ko|nl|pl|pt-br|ru|tr|zh-cn|zh-tw]
```

--------------------------------

### Get APIConnect Toolkit Version (apic version)

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/analytics/version/apic_version

Retrieves the current version of the APIConnect toolkit. This command can be used with or without specific flags to display the version information. No external dependencies are required beyond the APIConnect CLI installation.

```bash
apic version --mode analytics [flags]
```

--------------------------------

### Example Keystore Creation with Certificate and Private Key

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/keystores/apic_keystores_create

This example demonstrates the creation of a keystore using a provided certificate and RSA private key. The `keystore` variable contains the PEM-encoded certificate and private key, and the `name`, `password`, and `summary` fields provide metadata for the keystore.

```bash
keystore:"-----BEGIN CERTIFICATE-----
MIIC7jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG
A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3BxETAPBgNVBAoTCEZyYW5rNERE
MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBucnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl
YiCDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw
ODIyMDUyNzQxWhcNMTcwODIxMDUyNzQxWeBKMQswCQYDVQQGEwJKUDEOMAwGA1UE
CAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA93d3cuZXhhbXBs
ZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC0z9FeMynsC8+u
dvX+LciZxnh5uRj4C9S6tNeeAlIGCfQYk0zUcNFCoCkTknNQd/YEiawDLNbxBqut
bMDZ1aarys1a1lYmUeVLCIqvzBkPJTSQsCopQQ9V8WuT252zzNzs68dVGNdCJd5J
NRQykpwexmnjPPv0mvj7i8XgG379TyW6P+WWV5okeUkXJ9eJS2ouDYdR2SM9BoVW
+FgxDu6BmXhozW5EfsnajFp7HL8kQClI0QOc79yuKl3492rH6bzFsFn2lfwWy9ic
7cP8EpCTeFp1tFaD+vxBhPZkeTQ1HKx6hQ5zeHIB5ySJJZ7af8W8r4eTGYzbdRW2
4DDHCPhZAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAQMv+BFvGdMVzkQaQ3/+2noVz
/uAKbzpEL8xTcxYyP3lkOeh4FoxiSWqy5pGFALdPONoDuYFpLhjJSZaEwuvjI/Tr
rGhLV1pRG9frwDFshqD2Vaj4ENBCBh6UpeBop5+285zQ4SI7q4U9oSebUDJiuOx6
+tZ9KynmrbJpTSi0+BM=
-----END
  CERTIFICATE-----
-----BEGIN RSA PRIVATE KEY-----
MII7pAIBABKCAQEAtM/RXjMp7AvPrnb1/i3ImcZ4ebkY+AvUurTXngJSBgn0GJNM
1HDRQqApE5JzUHf2BImsAyzW8QarrWzA2dWmq8rNWtJWJlHlSwiKr8wZDyU0kLAq
KUEPVfFrk9uds8zc7OvHVRjXQiXeSTUUMpKcHsZp4zz79Jr4+4vF4Bt+/U8luj/l
lleaJHlJFyfXiUtqLg2HUdkjPQaFVvhYMQ7ugZl4aM1uRH7J2oxaexy/JEApSNED
nO/cripd+Pdqx+m8xbBZ9pX8FsvYnO3D/BKQk3hadbRWg/r8QYT2ZHk0NRyseoUO
c3hyAeckiSWe3n9lvK+HkxmM23UVtuAwxwj4WQIDAQABAoIBAE76H0d4La2PEy3v
hE98DA0vJdx1PzTJZigPacb42H8OxfIeFQcOKDlj381OwNO7MliVEe9pHJG3CjH8
ONhtfBm5wa0UBtFCIFd/6aQUEDYPWECC0kemxV4Sz5yL5vxsVWufKThAW3XnOIrd
hm74nvzKSeIZ9yvGrU6ipNHY8MUPm0DQVrVYE5MiKjKVExQ4uRAolV2hlmeQDlSt
k85S0TUOWO1EvJZhsVVs7dBjjY10hIjv3gZPAO8CN75JzMeaNbmWv4RQj0B967in
rqlOa5qYYt80tAWO4hmPRKCrv6PgThz8C0Cd8AgwNzvQD2d4JpmxxTzBT6/5lRng
Hhj/wQECgYEA2jxC0a4lGmp1q2aYE1Zyiq0UqjxA92pwFYJg3800MLkf96A+dOhd
wDAc5aAKN8vQV5g33vKi5+pIHWUCskhTS8/PPGrfeqIvtphCj6b7LKosBOhdzrRD
Osr+Az/SiR2h5l2lr/v7I8I86RTY7MBk4QcRb601kSagWLDNVzSSdhECgYEA1Bm0
0sByqkQmFoUNRkwmShPfJeVLTCr1G4cllml6MqHmGyRDHxtcp1+CXlyJJemLQY2A
qrM7/T4x2ta6ME2WgDydFe9M8oU3BbefNYovS6YnoyBqxCx7yZ1vO0Jo40rZI8Bi
KoCi6e0Hugg4xyPRz9TTNLmr/yEC1qQesMhM9ckCgYEArsT7rfgMdq8zNOSgfTwJ
1sztc7d1P67ZvCABfLlVRn+6/hAydGVyTus4+RvFkxGB8+RPOhiOJbQVtJSkKCqL
qnbtu7DK7+ba1xvwkiJjnE1bm0KLfXIXNQpDik6eSHiWo2nzuo/Ne8GeDftIDbG2
GBAVAp5v+6I3X0+X4nKTqEECgYEAwT4Cj5mjXxnkEdR7eahHwmpEf0RfzC+/Tate
RXZsrUDwY34wYWEOk7fjEZIBqrcTl1ATEHNojpxh096bmHK4UnHnNRrn4nYY4W6g
8ajK2oOxzWA1pjJZPiHgO/+PjLafC4G2br7wr2y0A3yGLnmmKVLgc0NPP42WBnVV
OP/ljnECgYABlDdJCAehDNSv4mdEzY5bfD+VBFd2QsgE1hYhmUYYRNlgIfIL9Y8e
CduqXFLNZ/LHdmtYembgUqrMiJTUqcbSrJt26kBQx0az3LAV+J2p68PQ85KR9ZPy
N1jEnRqpAwEdw7S+8l0yVyaNkm66eRI80p+w3AxNbS9hJ/7UlV3lGA==
-----END
  RSA PRIVATE KEY-----
" name: acme-keystore password: Acme1234 summary: An example keystore creation title: Acme keystore creation
```

--------------------------------

### apic role:get

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/portaladmin/role/apic_role_get

Gets a Drupal User Role defined on the site and all the permissions it has been granted.

```APIDOC
## GET /role/get

### Description
Retrieves a specific role and its granted permissions from the site.

### Method
GET

### Endpoint
/role/get

### Parameters
#### Query Parameters
- **server** (string) - Required - Management server endpoint.
- **catalog** (string) - Required - Name or ID of the Catalog.
- **org** (string) - Required - Name or ID of the organization.
- **mode** (string) - Optional - Toolkit operation mode (default: "apim").
- **format** (string) - Optional - Output format. One of [json yaml octet-stream go-template=... go-template-file=...], defaults to yaml.

#### Path Parameters
- **ROLE** (string) - Required - The name or ID of the role to retrieve.

### Request Example
```bash
apic role:get --mode portaladmin --server **api** --catalog **catalog** --org **org** administrator
```

### Response
#### Success Response (200)
- **role_name** (string) - The name of the role.
- **permissions** (array) - A list of permissions granted to the role.

#### Response Example
```json
{
  "role_name": "administrator",
  "permissions": [
    "manage_users",
    "manage_catalogs"
  ]
}
```
```

--------------------------------

### GET /rulesets:get

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/governance/rulesets/apic_rulesets_get

Downloads a specific Ruleset object as a file to the current directory or specified output path.

```APIDOC
## GET apic rulesets:get

### Description
Downloads the Ruleset object as a file to the current directory by name or id. This command requires governance mode to be enabled.

### Method
GET

### Endpoint
apic rulesets:get --mode governance [flags] RULESET

### Parameters
#### Path Parameters
- **RULESET** (string) - Required - The name or ID of the ruleset to download.

#### Query Parameters
- **--fields** (string) - Optional - List of field names to return.
- **--format** (string) - Optional - Output format (json, yaml, octet-stream, etc.). Defaults to yaml.
- **--org** (string) - Required - Organization name or id.
- **--output** (string) - Optional - Directory to write file(s) to, use - for STDOUT.
- **--ruleset_version** (string) - Optional - Specify an explicit Ruleset version.
- **--server** (string) - Required - Management server endpoint.

### Request Example
```bash
apic rulesets:get --mode governance --org my-org --server my-server my-ruleset-id
```

### Response
#### Success Response (200)
- **file** (binary/text) - The downloaded Ruleset object file.

#### Response Example
```yaml
# Ruleset content in YAML format
name: my-ruleset
version: 1.0.0
rules:
  - id: rule-1
    severity: error
```
```

--------------------------------

### Project Configuration File Example

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/projects/apic_projects_create

A YAML-formatted configuration file used as input for the project creation command. It defines the API version, name, summary, and project title.

```yaml
api_version: 2.0.0
name: sample-project
summary: A sample project for demonstrating the project create command
title: My Sample API Project update title
type: project
```

--------------------------------

### GET notification-styles:get

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/notification-styles/apic_notification-styles_get

Retrieves notification styles from the IBM API Connect management server based on the specified scope.

```APIDOC
## GET notification-styles:get

### Description
Retrieves notification styles configuration from the management server. Requires specific scope parameters to define the context of the notification styles.

### Method
GET

### Endpoint
apic notification-styles:get

### Parameters
#### Query Parameters
- **--scope** (string) - Required - The scope of the notification styles (org, consumer, cloud, or catalog).
- **-c, --catalog** (string) - Required - Catalog name or id.
- **-o, --org** (string) - Required - Organization name or id.
- **-s, --server** (string) - Required - Management server endpoint.
- **--fields** (string) - Optional - List of field names to return.
- **--format** (string) - Optional - Output format (json, yaml, octet-stream, go-template).

### Request Example
`apic notification-styles:get --scope org --org my-org --server my-server.com`

### Response
#### Success Response (200)
- **output** (object/file) - Returns the notification styles configuration in the requested format (default: yaml).

#### Response Example
```yaml
notification_styles:
  enabled: true
  theme: default
```
```

--------------------------------

### API Key Configuration Example

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/api-keys/apic_api-keys_create

An example configuration file structure for creating an API Key. This YAML-formatted input defines the client type, description, name, and token expiration settings.

```yaml
client_type: toolkit
description: acme api key
name: acme-apikey
token_exp: 3719
ttl: 4150
```

--------------------------------

### Mail Server Creation Configuration Example

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/mail-servers/apic_mail-servers_create

This YAML snippet provides an example configuration for creating a mail server. It includes essential details such as credentials, host, name, port, security settings, and an optional TLS client profile URL.

```yaml
credentials:
  password: Passw0rd123
  username: acmeuser
host: acme.example.com
name: acme-mailserver
port: 25
secure: true
title: acme mail server
tls_client_profile_url: https://acme-apim.example.com/api/orgs/org1/tls-client-profiles/tls-client-profile1
```

--------------------------------

### GET apic org-settings:get

Source: https://ibm-apiconnect.github.io/clidocs/docs/tags/group-org-settings

Retrieves the current organization settings object.

```APIDOC
## GET apic org-settings:get

### Description
Retrieves the configuration details for the organization settings.

### Method
GET

### Endpoint
apic org-settings:get

### Parameters
#### Path Parameters
- **org** (string) - Required - The organization name or ID.

### Request Example
`apic org-settings:get --org my-org`

### Response
#### Success Response (200)
- **settings** (object) - The organization settings object.

#### Response Example
{
  "id": "org-123",
  "name": "my-org",
  "settings": {
    "catalog_creation_enabled": true
  }
}
```

--------------------------------

### Get Role Command Synopsis

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/portaladmin/role/apic_role_get

This snippet shows the basic syntax for the 'apic role:get' command. It is used to retrieve a role and its permissions from the API Connect site.

```bash
apic role:get --mode portaladmin [flags]
```

--------------------------------

### apic apis:get Usages with ID and Scope

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/apis/apic_apis_get

Demonstrates how to use the 'apic apis:get' command to retrieve APIs by their ID within a specific scope (space or catalog).

```bash
apic apis:get [flags] --id --scope space ID
apic apis:get [flags] --id --scope catalog ID
```

--------------------------------

### Draft Product Creation Example (YAML)

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/draft-products/apic_draft-products_create

This example demonstrates the structure of a draft product definition in YAML format. It includes details such as API references, gateway information, product metadata, plans with rate limits, and visibility settings.

```yaml
apis:
  acme-api1.0.0:
    name: acme-api:1.0.0
  acme2-api1.0.0:
    name: acme2-api:1.0.0
gateways:
- datapower-api-gateway
info:
  name: acme-draft-product
  summary: An example draft product creation
  title: acme draft product creation
  version: 1.0.0
plans:
  default-plan:
    description: Default Plan
    rate-limits:
      default:
        value: 100/1hour
    title: Default Plan
product: 1.0.0
visibility:
  subscribe:
    enabled: true
    type: authenticated
  view:
    enabled: true
    type: public

```

--------------------------------

### apic apis:get Command Synopsis

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/apis/apic_apis_get

This snippet shows the basic structure of the 'apic apis:get' command. It's used to retrieve information about APIs within the system.

```bash
apic apis:get [flags]
```

--------------------------------

### View help for summary command

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/analytics/summary/apic_summary

Displays the help menu for the summary command to list available options and usage instructions.

```bash
apic summary --help
```

--------------------------------

### Example: Deleting Configuration Variables

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/analytics/config/apic_config_delete

Illustrates example usage of the 'apic config:delete' command. The specific examples are not provided in the input but this entry represents where they would be shown.

```bash
cmd_config_delete_examplesanalytics
```

--------------------------------

### Create a Project using apic CLI

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/projects/apic_projects_create

This command initializes a project object based on a provided configuration file. It requires the --org and --server flags to define the target environment.

```bash
apic projects:create [flags] PROJECT_FILE
```

--------------------------------

### GET /memcache:get

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/portaladmin/memcache/apic_memcache_get

Retrieves the memcache enabled status for a specified Developer Portal site.

```APIDOC
## GET apic memcache:get

### Description
Gets the memcache enabled status on a specific Developer Portal site.

### Method
GET

### Endpoint
apic memcache:get --mode portaladmin [flags]

### Parameters
#### Query Parameters
- **--mode** (string) - Required - Toolkit operation mode (must be 'portaladmin')
- **-c, --catalog** (string) - Required - Name or ID of the Catalog that the site belongs to.
- **-o, --org** (string) - Required - Name or ID of the organization that the catalog belongs to.
- **-s, --server** (string) - Required - Management server endpoint.
- **--format** (string) - Optional - Output format. One of [json yaml octet-stream go-template=... go-template-file=...], defaults to yaml.

### Request Example
```bash
apic memcache:get --mode portaladmin --server example.com --org my-org --catalog my-catalog
```

### Response
#### Success Response (200)
- **status** (boolean) - Indicates whether memcache is enabled for the site.

#### Response Example
```yaml
memcache_enabled: true
```
```

--------------------------------

### apic extensions:create Command Options

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/extensions/apic_extensions_create

Lists the available options for the 'apic extensions:create' command, including required parameters like catalog, configured-gateway-service, org, and server, as well as output formatting and scope specification.

```bash
--catalog string
      Catalog name or id (required)
      --configured-gateway-service string
    Configured Gateway Service name or id (required)
      --format string
    Output format. One of [json yaml octet-stream go-template=... go-template-file=...], defaults to yaml.
      -h, --help
    Help for extensions:create
      -o, --org string
    Organization name or id (required)
      --output string
    Write file(s) to directory, instead of STDOUT (default "-")
      --scope string
    scope
      -s, --server string
    management server endpoint (required)
      --space string
    Space name or id (required)
```

--------------------------------

### GET apic-config:get

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/portaladmin/apic-config/apic_apic-config_get

Retrieves the configuration object held by the developer portal as sent by APIM.

```APIDOC
## GET apic-config:get

### Description
Retrieves the configuration object that the developer portal holds, which was originally sent by APIM.

### Method
CLI Command (apic-config:get)

### Endpoint
apic apic-config:get --mode portaladmin [flags]

### Parameters
#### Required Flags
- **--mode** (string) - Required - Set to 'portaladmin' for this operation.
- **-c, --catalog** (string) - Required - Name or ID of the Catalog that the site belongs to.
- **-o, --org** (string) - Required - Name or ID of the organization that the catalog belongs to.
- **-s, --server** (string) - Required - Management server endpoint.

#### Optional Flags
- **--format** (string) - Optional - Output format. One of [json, yaml, octet-stream, go-template=..., go-template-file=...]. Defaults to yaml.

### Request Example
`apic apic-config:get --mode portaladmin --catalog my-catalog --org my-org --server https://management-server.com`

### Response
#### Success Response
- **configuration** (object/file) - The configuration object in the requested format (JSON/YAML).

#### Response Example
```yaml
config:
  site_id: "12345"
  status: "active"
```
```

--------------------------------

### GET associates:get

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/associates/apic_associates_get

Retrieves associate operations based on the specified scope and organizational parameters.

```APIDOC
## GET associates:get

### Description
Retrieves associate operations for a given scope within an IBM API Connect environment.

### Method
GET

### Endpoint
apic associates:get

### Parameters
#### Query Parameters
- **catalog** (string) - Required - Catalog name or id
- **consumer-org** (string) - Required - Consumer Organization name or id
- **org** (string) - Required - Organization name or id
- **server** (string) - Required - Management server endpoint
- **space** (string) - Required - Space name or id
- **scope** (string) - Optional - The scope of the associate operation
- **fields** (string) - Optional - List of field names to return
- **format** (string) - Optional - Output format (json, yaml, octet-stream, etc.)

### Request Example
`apic associates:get --server https://mgmt.example.com --org my-org --catalog my-catalog --space my-space --consumer-org my-consumer-org --scope org`

### Response
#### Success Response (200)
- **data** (object) - The requested associate operation details in the specified format.

#### Response Example
```yaml
associate:
  id: "12345"
  name: "example-associate"
  status: "active"
```
```

--------------------------------

### Example Extension Creation at Catalog Scope (YAML)

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/extensions/apic_extensions_create

A sample YAML configuration demonstrating the structure of an extension definition for creation at the catalog scope. It includes metadata like version, contact information, description, license, and name.

```yaml
extension: 1.0.0
info:
  contact:
    email: acme@example.com
    name: Aaron Cohen
    url: http://acme.example.com
  description: An example extension creation.
  license:
    name: Tom Clayton
    url: http://acmelicense.example.com
  name: acme-extension
  termsOfService: https://www.acme.com/legal
  title: Acme extension creation
  version: 1.0.0
```

--------------------------------

### List Application Credentials Command Usages

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/credentials/apic_credentials_list

Demonstrates various ways to use the 'apic credentials:list' command with different scope and initiation flags. These examples show how to target specific application credentials based on their context.

```bash
apic credentials:list [flags] --scope app --space-initiated
apic credentials:list [flags] --space-initiated
apic credentials:list [flags] --scope space
apic credentials:list [flags] --scope catalog
apic credentials:list [flags] --scope app
apic credentials:list [flags]
```

--------------------------------

### GET /apic config:get

Source: https://ibm-apiconnect.github.io/clidocs/docs/category/portal-admin

Retrieves the value of a specific configuration variable from the developer portal.

```APIDOC
## GET apic config:get

### Description
Fetches the current value of a specific configuration variable stored in the developer portal.

### Method
GET

### Endpoint
apic config:get

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of the configuration variable to retrieve.

### Response
#### Success Response (200)
- **value** (string) - The value associated with the configuration key.

#### Response Example
{
  "name": "site_title",
  "value": "My Developer Portal"
}
```

--------------------------------

### Catalog Configuration File Example

Source: https://ibm-apiconnect.github.io/clidocs/docs/v1210/apim/catalogs/apic_catalogs_create

A YAML-formatted configuration file defining the essential properties for a new catalog, such as name, owner URL, summary, and title.

```yaml
name: acme-catalog
owner_url: https://api.acme-apim.example.com/api/user-registries/acme-org/acme-user-registry/users/acme-user
summary: An example catalog create
title: ACME Catalog
```
Tokens:
Raw