SAP Business Technology Platform (SAP BTP)

https://help.sap.com/docs/btp
Admin
SAP Business Technology Platform (SAP BTP) allows users to extend and personalize SAP applications,...
Tokens:1,484,505
Snippets:23,562
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Setup Namespaces for Multi-Workload Example

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/exposing-multiple-workloads

Create namespaces and enable Istio sidecar proxy injection for the example deployment.

```bash
kubectl create ns httpbin-a
kubectl label namespace httpbin-a istio-injection=enabled --overwrite
kubectl create ns httpbin-b
kubectl label namespace httpbin-b istio-injection=enabled --overwrite
kubectl create ns apirule
kubectl label namespace apirule istio-injection=enabled --overwrite
```

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

### btp get accounts/subscription example

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-get-accounts-subscription

A concrete example of retrieving subscription details for a specific application and plan.

```bash
btp get accounts/subscription --subaccount my-subaccount-id --of-app my-application-name --plan my-app-plan-name --show-parameters
```

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

### Example of btp get accounts/environment-instance

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-get-accounts-environment-instance

A concrete example showing how to specify the environment instance ID and the subaccount ID.

```bash
btp get accounts/environment-instance my-environment-instance-id --subaccount my-subaccount-id
```

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

### Basic Getting Started Commands

Source: https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/command-syntax-of-btp-cli?locale=en-US&state=PRODUCTION&version=Cloud

Common commands to list or retrieve information about accounts and security entities.

```bash
btp list accounts/subaccount
```

```bash
btp list security/user
```

```bash
btp get security/user "name@example.com"
```

```bash
btp list accounts/subscription
```

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

### Examples of btp get accounts/available-environment

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-get-accounts-available-environment

Specific command examples for querying environment details, with and without explicit subaccount targeting.

```bash
btp get accounts/available-environment --environment cloudfoundry --service cloud_foundry --plan system
```

```bash
btp get accounts/available-environment --subaccount my-subaccount-id --environment cloudfoundry --service cloud_foundry --plan system
```

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

### Examples of btp get services/offering

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-get-services-offering

Various ways to query service offering details using names or IDs.

```bash
btp get services/offering --name service-offering-name --subaccount my-subaccount
```

```bash
btp get services/offering --id service-offering-id --subaccount my-subaccount
```

```bash
btp get services/offering service-offering-id --subaccount my-subaccount
```

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

### Examples of btp get security/available-idp

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-get-security-available-idp

Examples showing how to retrieve tenant details using either a global account subdomain or a subaccount ID.

```bash
btp get security/available-idp myidp.accounts500.ondemand.com --global-account my-subdomain
```

```bash
btp get security/available-idp myidp.accounts500.ondemand.com --subaccount my-subaccount-id
```

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

### Install Local Server Runtime

Source: https://help.sap.com/docs/btp/sap-btp-neo-environment/deploy-locally-with-console-client?q=%22user+base%22

Installs a server runtime in the default <SDK installation folder>/server directory.

```bash
neo install-local
```

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

### Example TENANT_HOST_PATTERN Configuration

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/subdomain-does-not-map-to-valid-identity-zone

Concrete example of a manifest.yml configuration for a specific application and landscape.

```yaml
env:
									XSAPPNAME: "bulletinboard-123456"
									TENANT_HOST_PATTERN: "^(.*)-approuter-123456.cfapps.eu10.hana.ondemand.com".
```

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

### Start local server

Source: https://help.sap.com/docs/btp/sap-btp-neo-environment/deploy-locally-with-console-client

Starts the local server instance from the tools folder.

```bash
neo start-local
```

```bash
--location <local server directory>
```

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

### Install btp CLI via script

Source: https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/8a8f17f5fd334fb583438edbd831d506.html?locale=en-US&state=PRODUCTION&version=Cloud

Executes the installation script directly in the terminal to guide the user through the setup process.

```bash
curl https://cli.btp.cloud.sap/btpcli-install.sh | bash
```

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

### Create Virtual Machine Example

Source: https://help.sap.com/docs/btp/sap-btp-neo-environment/create-vm

A practical example of the create-vm command using specific account, user, host, name, and size parameters.

```bash
neo create-vm --account mysubaccount --user mymail@example.com --host hana.ondemand.com --name myvm --size x-small
```

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

### Download keystore examples

Source: https://help.sap.com/docs/btp/sap-btp-neo-environment/download-keystore?locale=en-US&state=PRODUCTION&version=Cloud

Examples for downloading keystores at subscription, application, and subaccount levels.

```bash
neo download-keystore --account <consumer_subaccount_technical_name> --application <provider_subaccount_technical_name>:<provider_application_name>
--user <e-mail_or_user> --location c:\temp --name KeyStore1 --host hana.ondemand.com
```

```bash
neo download-keystore --account <consumer_subaccount_technical_name> --application <consumer_application_name>
--user <user_ID> --location c:\temp --name KeyStore1 --host hana.ondemand.com
```

```bash
neo download-keystore --account <consumer_subaccount_technical_name> --user <e-mail_or_user> 
--location c:\temp --name KeyStore1 --host hana.ondemand.com
```

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

### Get Gateway Hosts Example

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/migrate-multiple-apirules-targeting-same-workload-from-v1beta1-to-v2

An example command to retrieve hosts from the 'kyma-gateway' in the 'kyma-system' namespace.

```bash
kubectl get gateway -n kyma-system kyma-gateway -o jsonpath='{.spec.servers[0].hosts}'
["*.local.kyma.dev"]%
```

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

### Create service instance examples

Source: https://help.sap.com/docs/BTP/btp-cli/btp-create-services-instance.html

Various command examples for creating service instances using different parameter combinations.

```bash
btp create services/instance --subaccount my-subaccount --offering-name offering-name --plan-name plan-name --name my-instance-name
```

```bash
btp create services/instance --subaccount my-subaccount --offering-name offering-name --data-center Paris --plan-name plan-name --name my-instance-name
```

```bash
btp create services/instance --offering-name offering-name --plan-name plan-name --name my-instance-name --parameters ~/Documents/parameters.json
```

```bash
btp create services/instance --subaccount my-subaccount --plan plan-id --name my-instance-name
```

```bash
btp create services/instance --plan plan-id --name my-instance-name --parameters ~/Documents/parameters.json
```

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

### Perform whitelistService GET Request

Source: https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/whitelistservice?locale=en-US&state=PRODUCTION&version=Cloud

Example of a GET request to the whitelistService endpoint with a URL-encoded parentOrigin parameter.

```http
GET url/to/whitelist/service?parentOrigin=https://parent.domain.acme.com
```

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

### Get Service Selector Example

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/migrate-multiple-apirules-targeting-same-workload-from-v1beta1-to-v2

An example command to retrieve the selector for the 'httpbin' service in the 'default' namespace.

```bash
kubectl get service httpbin -n default -o jsonpath='{.spec.selector}'
{"app":"httpbin"}%
```

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

### Create ASE Database Example

Source: https://help.sap.com/docs/btp/sap-btp-neo-environment/create-db-ase

A concrete example demonstrating the command with placeholder values for account, host, system, and database configuration.

```bash
neo create-db-ase -a mysubaccount -h hana.ondemand.com -u mymail@example.com --dbsystem mydbsys -i mydb --db-user mydbuser --db-password SECRET --db-size mydbsize
```

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

### Create Service Binding Examples

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-create-services-binding?version=Cloud

Various examples demonstrating how to create service bindings using instance names or IDs, with or without external parameter files.

```bash
btp create services/binding --name my-binding-name --instance-name my-service-instance-name --subaccount my-subaccount
```

```bash
btp create services/binding --name my-binding-name --service-instance my-service-instance-id --subaccount my-subaccount
```

```bash
btp create services/binding --name my-binding-name --instance-name my-service-instance-name --parameters ~/Documents/parameters.json
```

```bash
btp create services/binding --name my-binding-name --service-instance my-service-instance-id --parameters ~/Documents/parameters.json
```

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

### Read Pull Request Example

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/read-pull

Example of an HTTP GET request to read a specific pull job by its UUID.

```http
GET /sap/opu/odata/sap/MANAGE_GIT_REPOSITORY/Pull(uuid=02409ac8-dc6a-1edb-908e-31e4b44596d4’) HTTP/1.1

Host: host.com
Authentication: basicAuthentication
Accept: application/json


```

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

### Example of btp get disaster-recovery/subaccount-pair

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-get-disaster-recovery-subaccount-pair?locale=en-US&state=PRODUCTION&version=Cloud

A concrete example showing how to query a subaccount pair using a specific ID.

```bash
btp get disaster-recovery/subaccount-pair --subaccount my-subaccount-id
```

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

### Register a platform example

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-register-services-platform

A basic example of registering a platform with a name and subaccount ID.

```bash
btp register services/platform --name my-platform --subaccount my-subaccount-id
```

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

### Deploy HTTPBin Sample

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/expose-and-secure-workload-with-oauth2-proxy-external-authorizer-authorization-code-flow

Create a namespace and deploy the HTTPBin sample application for testing.

```bash
kubectl create ns httpbin-system
kubectl label namespace httpbin-system istio-injection=enabled
kubectl apply -f \
https://raw.githubusercontent.com/istio/istio/master/samples/httpbin/httpbin.yaml \
-n httpbin-system
```

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

### Handle Plugin Installation Error

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/install-multiapps-cli-plugin-in-cloud-foundry-environment

Example of the error message displayed when attempting to install the plugin while conflicting commands exist.

```text
Plugin multiapps v<version> could not be installed as it contains commands with names and aliases that are already used: 
bg-deploy, deploy, download-mta-op-logs, mta, mta-ops, mtas, purge-mta-config, undeploy, dmol
```

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

### List Application Data Sources Example

Source: https://help.sap.com/docs/btp/sap-btp-neo-environment/list-application-datasources?locale=en-US&state=PRODUCTION&version=Cloud

Example usage of the command with specific subaccount, application, host, and user credentials.

```bash
neo list-application-datasources -a mysubaccount -b myapp -h hana.ondemand.com -u mymail@example.com
```

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

### Example of btp get security/trust

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-get-security-trust

A basic example showing how to retrieve details for a trust configuration using its origin key.

```bash
btp get security/trust ORIGIN
```

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

### Example of create-db-user-ase command

Source: https://help.sap.com/docs/btp/sap-btp-neo-environment/create-db-user-ase

A concrete example showing how to execute the command with specific parameters.

```bash
neo create-db-user-ase -a mysubaccount -h hana.ondemand.com -u mymail@example.com -i mydb --db-user mydbuser --db-password SECRET
```

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

### Get Application State

Source: https://help.sap.com/docs/btp/sap-btp-neo-environment/java-alm-api

Verifies the current state of the application to confirm it has successfully started.

```HTTP
Client Request:

GET: https://api.hana.ondemand.com/lifecycle/v1/accounts/mysubaccount/apps/myapp/state
```

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

### List Service Offerings Examples

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-list-services-offering

Various examples demonstrating how to filter and display service offerings using different command parameters.

```bash
btp list services/offering --subaccount my-subaccount --environment kubernetes
```

```bash
btp list services/offering --subaccount my-subaccount
```

```bash
btp list services/offering --show-data-center
```

```bash
btp list services/offering --labels-filter "environment eq 'test'"
```

```bash
btp list services/offering --fields-filter "name eq 'my service offering name'"
```

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

### Sample Binding Commands

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/bind-multitenant-application-and-application-router-to-xsuaa-service-instance?locale=en-US&state=PRODUCTION&version=Cloud

Example commands showing the binding process for both the application and the approuter.

```bash
cf bind-service saas-app xsuaa-application

cf bind-service approuter-saas-app xsuaa-application
```

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

### GET Request for Tags

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/read-entities-from-tag

Use this GET request to retrieve entities associated with tags. Ensure to set the Host and Accept headers appropriately. The Authentication header is also shown as an example.

```http
GET /sap/opu/odata/sap/Tags 

Host: host.com
Authentication: basicAuthentication
Accept: application/json

```

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

### List Volume Snapshots Example

Source: https://help.sap.com/docs/btp/sap-btp-neo-environment/list-volume-snapshots

A practical example of the command using specific account, host, and user credentials.

```bash
neo list-volume-snapshots --account mysubaccount --host hana.ondemand.com --user myemail@example.com
```

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

### Examples of btp get accounts/global-account

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-get-accounts-global-account?version=Cloud

Common command variations for viewing global account information.

```bash
btp get accounts/global-account
```

```bash
btp get accounts/global-account --show-hierarchy
```

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

### Example Route Mapping for Icons

Source: https://help.sap.com/docs/btp/sap-btp-neo-environment/accessing-application-resources?locale=en-US&state=PRODUCTION&version=Cloud

Maps all requests starting with /icons to the active version of the iconlibrary application.

```json
...
"routes": [
             {
           "path": "/icons", 
           "target": {
               "type": "application",
               "name": "iconlibrary"
               },
           "description": "Icon Library"
             }
          ]
...
```

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

### Deploy Sample HTTPBin Services

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/exposing-multiple-workloads

Apply the HTTPBin sample manifests to the specified namespaces.

```bash
kubectl apply -n httpbin-a -f https://raw.githubusercontent.com/istio/istio/master/samples/httpbin/httpbin.yaml
kubectl apply -n httpbin-b -f https://raw.githubusercontent.com/istio/istio/master/samples/httpbin/httpbin.yaml
```

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

### Example of listing environment instances

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-list-accounts-environment-instance

A concrete example showing how to list environment instances for a specific subaccount ID.

```bash
btp list accounts/environment-instance --subaccount my-subaccount-id
```

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

### Example Buildpack Version Lists

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/sap-java-buildpack

Sample output from the cf buildpacks command showing version transitions.

```text
buildpack                position    enabled     locked    filename

sap_java_buildpack           1         true      false     sap_java_buildpack-v1.114.0.zip
sap_java_buildpack_1_114     2         true      false     sap_java_buildpack-v1.114.0.zip
sap_java_buildpack_1_113     3         true      false     sap_java_buildpack-v1.113.0.zip
sap_java_buildpack_1_112     4         true      false     sap_java_buildpack-v1.112.0.zip
```

```text
buildpack                position    enabled     locked    filename

sap_java_buildpack           1         true      false     sap_java_buildpack-v1.115.0.zip
sap_java_buildpack_1_115     2         true      false     sap_java_buildpack-v1.115.0.zip
sap_java_buildpack_1_114     3         true      false     sap_java_buildpack-v1.114.0.zip
sap_java_buildpack_1_113     4         true      false     sap_java_buildpack-v1.113.0.zip
```

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

### Example: Get resource provider details

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-get-accounts-resource-provider?version=Cloud

Retrieves details for an AWS resource provider instance named 'my_resource_provider'.

```bash
btp get accounts/resource-provider --provider AWS --technical-name my_resource_provider
```

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

### GET Request with Language Setting

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/read-application-job-status-texts

This example shows how to optionally specify the language for the response using the 'sap-language' query parameter.

```http
GET <host>/sap/opu/odata/SAP/BC_EXT_APPJOB_MANAGEMENT;v=0002/JobStatusInfoSet?sap-language=EN
```

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

### Examples of updating environment instances

Source: https://help.sap.com/docs/BTP/btp-cli/btp-update-accounts-environment-instance.html

Specific examples showing how to pass JSON parameters for adding or removing users in an environment instance.

```bash
btp update accounts/environment-instance my-environment-instance-id --subaccount my-subaccount-id --plan standard --parameters "{\"usersToAdd\":[{\"id\":\"myUserID\",\"email\":\"name@example.com\"}]}"
```

```bash
btp update accounts/environment-instance my-environment-instance-id --subaccount my-subaccount-id --plan standard --parameters "{\"usersToAdd\":[{\"id\":\"myUserID\",\"email\":\"name@example.com\",\"origin\":\"myCustomIdp\"}]}"
```

```bash
btp update accounts/environment-instance my-environment-instance-id --subaccount my-subaccount-id --plan standard --parameters "{\"usersToRemove\":[{\"id\":\"myUserID\",\"email\":\"name@example.com\"}]}"
```

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

### Filter Users by Username

Source: https://help.sap.com/docs/BTP/ea72206b834e4ace9cd834feed6c0e09/eb01a9f3ecad4a41a6033855ca61a9a8.html?locale=en-US&q=%22user+base%22&state=PRODUCTION&version=Cloud

Example URL structure for filtering users using a query parameter in an HTTP GET request.

```http
https://api.<cloud platform host>/authorization/v1/platform/accounts/<subaccount>/Users?filter=username eq "P1234567"
```

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

### Define a basic one-off task

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/tasks

Example configuration for a Node.js module defining a simple task executed via npm start.

```yaml
_schema-version: "3.1"
ID: foo
version: 3.0.0
modules:
  - name: foo
    type: javascript.nodejs
    parameters:
      no-route: true
      no-start: true
      disk-quota: 2GB
      tasks:
      - name: example_task
        command: npm start
        memory: 1GB
```

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

### List Trust Configurations Example

Source: https://help.sap.com/docs/btp/btp-cli-command-reference/btp-list-security-trust?version=Cloud

A basic example of executing the command to list trust configurations.

```bash
btp list security/trust
```

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

### Example: List Subaccounts with Verbose Option

Source: https://help.sap.com/docs/btp/sap-business-technology-platform/command-syntax-of-btp-cli

Demonstrates a basic command with the verbose option to get more detailed output when listing subaccounts.

```bash
btp --verbose list accounts/subaccount
```
Tokens:
Raw