{"id":20487580,"url":"https://github.com/ajmaradiaga/steampipe-plugin-btp","last_synced_at":"2025-04-13T15:41:31.248Z","repository":{"id":172220901,"uuid":"608128124","full_name":"ajmaradiaga/steampipe-plugin-btp","owner":"ajmaradiaga","description":" Steampipe plugin to access SAP Business Technology Platform","archived":false,"fork":false,"pushed_at":"2024-05-13T08:32:00.000Z","size":3776,"stargazers_count":7,"open_issues_count":1,"forks_count":1,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-06T11:06:33.140Z","etag":null,"topics":["api","btp","postgresql","postgresql-fdw","sap","sql","steampipe","steampipe-plugin"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ajmaradiaga.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-03-01T11:32:26.000Z","updated_at":"2024-01-08T07:21:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"fc99568c-7d10-4c52-9dc3-50549f02d81c","html_url":"https://github.com/ajmaradiaga/steampipe-plugin-btp","commit_stats":null,"previous_names":["ajmaradiaga/steampipe-plugin-btp"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajmaradiaga%2Fsteampipe-plugin-btp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajmaradiaga%2Fsteampipe-plugin-btp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajmaradiaga%2Fsteampipe-plugin-btp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajmaradiaga%2Fsteampipe-plugin-btp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ajmaradiaga","download_url":"https://codeload.github.com/ajmaradiaga/steampipe-plugin-btp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248739913,"owners_count":21154247,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","btp","postgresql","postgresql-fdw","sap","sql","steampipe","steampipe-plugin"],"created_at":"2024-11-15T16:49:40.353Z","updated_at":"2025-04-13T15:41:31.219Z","avatar_url":"https://github.com/ajmaradiaga.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"![image](https://hub.steampipe.io/images/plugins/ajmaradiaga/btp-social-graphic.png)\n\n# SAP BTP plugin for Steampipe\n\nUse SQL to query your SAP BTP account details.\n\n- **[Get started →](https://hub.steampipe.io/plugins/ajmaradiaga/btp)**\n- Documentation: [Table definitions \u0026 examples](https://hub.steampipe.io/plugins/ajmaradiaga/btp/tables)\n- Community: [Join #steampipe on Slack →](https://turbot.com/community/join)\n- Get involved: [Issues](https://github.com/ajmaradiaga/steampipe-plugin-btp/issues)\n\n## Quick start\n\n### Install\n\nDownload and install the latest SAP BTP plugin:\n\n```bash\nsteampipe plugin install ajmaradiaga/btp\n```\n\nConfigure your [credentials](https://hub.steampipe.io/plugins/ajmaradiaga/btp#credentials) and [config file](https://hub.steampipe.io/plugins/ajmaradiaga/btp#configuration).\n\nConfigure your account details in `~/.steampipe/config/btp.spc`:\n\n```hcl\nconnection \"btp\" {\n  plugin = \"ajmaradiaga/btp\"\n\n  # User email used to log in to SAP BTP. Required.\n  # This can also be set via the `BTP_USERNAME` environment variable.\n  # username = \"user@domain.com\"\n\n  # User password used to log in to SAP BTP. Required.\n  # This can also be set via the `BTP_PASSWORD` environment variable.\n  # password = \"My-BTP-Passw0rd\"\n\n  # You will need to create a service key for the Cloud Management Service. Required.\n  # You can get the instructions on how to get an access token for the SAP Cloud Management Service APIs here: https://help.sap.com/docs/btp/sap-business-technology-platform/getting-access-token-for-sap-cloud-management-service-apis.\n  # This can also be set via the `BTP_CIS_SERVICE_KEY_PATH` environment variable. Required.\n  # cis_service_key_path = \"~/service_keys/cis_global.json\"\n\n  # URL of the Accounts Service. Optional.\n  # This can also be set via the `BTP_CIS_ACCOUNTS_SERVICE_URL` environment variable.\n  # cis_accounts_service_url = \"https://accounts-service.cfapps.[region].hana.ondemand.com\"\n  \n  # URL of the Entitlements Service. Optional.\n  # This can also be set via the `BTP_CIS_ENTITLEMENTS_SERVICE_URL` environment variable.\n  # cis_entitlements_service_url = \"https://entitlements-service.cfapps.[region].hana.ondemand.com\"\n\n  # Access token to communicate with the Cloud Management Service APIs. Optional.\n  # You can get the instructions on how to get an access token for the SAP Cloud Management Service APIs here: https://help.sap.com/docs/btp/sap-business-technology-platform/getting-access-token-for-sap-cloud-management-service-apis. \n  # If no access token is provided, the plugin will try getting an access token using the details provided in cis_client_id, cis_client_secret, cis_token_url, username, password.\n  # This can also be set via the `BTP_CIS_ACCESS_TOKEN` environment variable.\n  # cis_access_token = \"eyJhbGciOiDBNsO0JxFoAaodkDJ3Pmk7cFEsEr5ml5BwNWEafrEjy8Hsxt2mVACpD8B4AIPpRuMoGE71qXGoPcW0vCugceTwN4C3xM8qYmH7DLQrdVIlSX6kydYxnRNjSO8je56ckA4oTC8wm2E2clClPhinDBN6DxHhXlB0eVJnerl4ONpxaH43PYXmHjIsArTuBGK6nCFtApIGN1OvMDPmjHFtOjNgcPCPC5GDXTt5oaB6M2gUrfD5QQVGA7L6yFQlXYPvF6BSyMxpoQXywMUwYA6oqV\"\n\n  # A service key (https://help.sap.com/docs/btp/sap-business-technology-platform/creating-service-keys) for the Central Management Service is required to get an access token.  \n  # The values for cis_client_id, cis_client_secret, cis_token_url can be retrieved from it. \n\n  # OAuth 2.0 Client ID (field in the service key: uua.clientid). Optional.\n  # This can also be set via the `BTP_CIS_CLIENT_ID` environment variable.\n  # cis_client_id = \"sb-ut-6y0m0wr1-ai10-1a56-4bv1-52m478h011g6-clone!b017880|cis-central!b14\"\n\n  # OAuth 2.0 Client Secret (field in the service key: uua.clientsecret). Optional.\n  # This can also be set via the `BTP_CIS_CLIENT_SECRET` environment variable. Optional.\n  # cis_client_secret = \"44s32264-285r-7101-g2n0-g036p1m214us$vm2_UCHAN_mX1FOW0lklBj2-igBsOUG77G-nE1TWsEu=\"\n\n  # OAuth 2.0 Token URL (field in the service key: uua.url). Optional.\n  # The value in the service key doesn't contain the path, /oauth/token, if not specified the plugin will append it automatically.\n  # This can also be set via the `BTP_CIS_TOKEN_URL` environment variable. Optional.\n  # cis_token_url = \"https://[global-account-subdomain].authentication.[region].hana.ondemand.com\"\n}\n```\n\nOr through environment variables:\n\n```sh\nexport BTP_USERNAME=user@domain.com\nexport BTP_PASSWORD=My-BTP-Passw0rd\nexport BTP_CIS_SERVICE_KEY_PATH=~/service_keys/cis_global.json\nexport BTP_CIS_ACCOUNTS_SERVICE_URL=https://accounts-service.cfapps.eu10.hana.ondemand.com\nexport BTP_CIS_ENTITLEMENTS_SERVICE_URL=https://entitlements-service.cfapps.eu10.hana.ondemand.com\nexport BTP_CIS_ACCESS_TOKEN=eyJhbGciOiDBNsO0JxFoAaodkDJ3Pmk7cFEsEr5ml5BwNWEafrEjy8Hsxt2mVACpD8B4AIPpRuMoGE71qXGoPcW0vCugceTwN4C3xM8qYmH7DLQ\n```\n\nRun steampipe:\n\n```shell\nsteampipe query\n```\n\nList your SAP BTP Global account details:\n\n```sql\nselect\n   guid,\n   display_name,\n   created_date,\n   modified_date \nfrom\n   btp_accounts_global_account;\n```\n\n```\n+--------------------------------------+-----------------------+---------------+---------------+\n| guid                                 | display_name          | created_date  | modified_date |\n+--------------------------------------+-----------------------+---------------+---------------+\n| 010788v8-7s64-1801-6680-l6g2253646b2 | My BTP global account | 1638221010619 | 1693587625761 |\n+--------------------------------------+-----------------------+---------------+---------------+\n```\n\n## Engines\n\nThis plugin is available for the following engines:\n\n| Engine        | Description\n|---------------|------------------------------------------\n| [Steampipe](https://steampipe.io/docs) | The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support.\n| [Postgres FDW](https://steampipe.io/docs/steampipe_postgres/overview) | Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Steampipe CLI, which ships with its own Postgres server instance, the Steampipe Postgres FDWs can be installed in any supported Postgres database version.\n| [SQLite Extension](https://steampipe.io/docs//steampipe_sqlite/overview) | Steampipe SQLite Extensions provide SQLite virtual tables that translate your queries into API calls, transparently fetching information from your API or service as you request it.\n| [Export](https://steampipe.io/docs/steampipe_export/overview) | Steampipe Plugin Exporters provide a flexible mechanism for exporting information from cloud services and APIs. Each exporter is a stand-alone binary that allows you to extract data using Steampipe plugins without a database.\n| [Turbot Pipes](https://turbot.com/pipes/docs) | Turbot Pipes is the only intelligence, automation \u0026 security platform built specifically for DevOps. Pipes provide hosted Steampipe database instances, shared dashboards, snapshots, and more.\n\n## Developing\n\nPrerequisites:\n\n- [Steampipe](https://steampipe.io/downloads)\n- [Golang](https://golang.org/doc/install)\n\nClone:\n\n```sh\ngit clone https://github.com/ajmaradiaga/steampipe-plugin-btp.git\ncd steampipe-plugin-btp\n```\n\nBuild, which automatically installs the new version to your `~/.steampipe/plugins` directory:\n\n```\nmake\n```\n\nConfigure the plugin:\n\n```\ncp config/* ~/.steampipe/config\nvi ~/.steampipe/config/btp.spc\n```\n\nTry it!\n\n```\nsteampipe query\n\u003e .inspect btp\n```\n\nFurther reading:\n\n- [Writing plugins](https://steampipe.io/docs/develop/writing-plugins)\n- [Writing your first table](https://steampipe.io/docs/develop/writing-your-first-table)\n\n## Open Source \u0026 Contributing\n\nThis repository is published under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) (source code) and [CC BY-NC-ND](https://creativecommons.org/licenses/by-nc-nd/2.0/) (docs) licenses. Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you!\n\n[Steampipe](https://steampipe.io) is a product produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source).\n\n## Get Involved\n\n**[Join #steampipe on Slack →](https://turbot.com/community/join)**\n\nWant to help but don't know where to start? Pick up one of the `help wanted` issues:\n\n- [Steampipe](https://github.com/turbot/steampipe/labels/help%20wanted)\n- [SAP BTP Plugin](https://github.com/ajmaradiaga/steampipe-plugin-btp/labels/help%20wanted)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajmaradiaga%2Fsteampipe-plugin-btp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fajmaradiaga%2Fsteampipe-plugin-btp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajmaradiaga%2Fsteampipe-plugin-btp/lists"}