{"id":28551985,"url":"https://github.com/heroku/heroku-api-plugin","last_synced_at":"2025-06-27T08:35:22.861Z","repository":{"id":34365701,"uuid":"38290242","full_name":"heroku/heroku-api-plugin","owner":"heroku","description":"Heroku API plugin for Heroku Toolbelt","archived":false,"fork":false,"pushed_at":"2025-04-29T17:17:59.000Z","size":651,"stargazers_count":33,"open_issues_count":9,"forks_count":14,"subscribers_count":92,"default_branch":"main","last_synced_at":"2025-06-10T04:07:53.552Z","etag":null,"topics":["heroku","heroku-cli-plugin"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/heroku.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-06-30T05:46:54.000Z","updated_at":"2025-04-29T17:18:01.000Z","dependencies_parsed_at":"2023-11-07T01:48:10.998Z","dependency_job_id":"aac738f1-d7c5-4745-a335-03107a71a1c3","html_url":"https://github.com/heroku/heroku-api-plugin","commit_stats":{"total_commits":143,"total_committers":13,"mean_commits":11.0,"dds":"0.30069930069930073","last_synced_commit":"c66c97eb1a591e0c640a9dc655c2e0df92d85f5a"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"purl":"pkg:github/heroku/heroku-api-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroku%2Fheroku-api-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroku%2Fheroku-api-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroku%2Fheroku-api-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroku%2Fheroku-api-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/heroku","download_url":"https://codeload.github.com/heroku/heroku-api-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroku%2Fheroku-api-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262223411,"owners_count":23277642,"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":["heroku","heroku-cli-plugin"],"created_at":"2025-06-10T04:07:53.880Z","updated_at":"2025-06-27T08:35:22.852Z","avatar_url":"https://github.com/heroku.png","language":"TypeScript","readme":"# API Plugin for Heroku Toolbelt\n\n[![npm version](https://badge.fury.io/js/heroku-api-plugin.svg)](http://badge.fury.io/js/heroku-api-plugin)\n![Node CI Suite](https://github.com/heroku/heroku-api-plugin/actions/workflows/ci.yml/badge.svg)\n[![Build status](https://ci.appveyor.com/api/projects/status/9i6wk4i1pe2hsss0/branch/master?svg=true)](https://ci.appveyor.com/project/Heroku/heroku-api-plugin/branch/master)\n\n## How to install this plugin\n\n```shell\n$ heroku plugins:install @heroku-cli/plugin-api\n```\n\n## Usage\n\n\u003c!-- commands --\u003e\n* [`heroku api METHOD [PATH]`](#heroku-api-method-path)\n\n## `heroku api METHOD [PATH]`\n\nmake a manual API request\n\n```\nUSAGE\n  $ heroku api METHOD [PATH] [-a \u003cvalue\u003e] [-b \u003cvalue\u003e] [-v \u003cvalue\u003e]\n\nARGUMENTS\n  METHOD  GET, POST, PUT, PATCH, or DELETE\n  PATH    endpoint to call\n\nFLAGS\n  -a, --accept-inclusion=\u003cvalue\u003e  Accept-Inclusion header to use\n  -b, --body=\u003cvalue\u003e              JSON input body\n  -v, --version=\u003cvalue\u003e           version to use (e.g. 2, 3, or 3.variant)\n\nDESCRIPTION\n  make a manual API request\n  The api command is a convenient but low-level way to send requests\n  to the Heroku API. It sends an HTTP request to the Heroku API\n  using the given method on the given path. For methods PUT, PATCH,\n  and POST, it uses stdin unmodified as the request body. It prints\n  the response unmodified on stdout.\n\n  It is essentially like curl for the Heroku API.\n\n  Method name input will be upcased, so both 'heroku api GET /apps' and\n  'heroku api get /apps' are valid commands.\n\nEXAMPLES\n  $ heroku api GET /apps/myapp\n  {\n    created_at: \"2011-11-11T04:17:13-00:00\",\n    id: \"12345678-9abc-def0-1234-456789012345\",\n    name: \"myapp\",\n    …\n  }\n\n  $ heroku api PATCH /apps/myapp/config-vars --body '{\"FOO\": \"bar\"}'\n  {\n    FOO: \"bar\"\n    …\n  }\n\n  $ printf '{\"updates\":[{\"type\":\"web\", \"quantity\":2}]}' | heroku api POST /apps/myapp/formation\n  [\n    {\n      \"app\": {\n        \"name\": \"myapp\",\n        \"id\": \"01234567-89ab-cdef-0123-456789abcdef\"\n      },\n      \"quantity\": 2,\n      \"type\": \"web\",\n      \"updated_at\": \"2012-01-01T12:00:00Z\"\n      ...\n    }\n  ]\n```\n\n_See code: [src/commands/api.ts](https://github.com/heroku/heroku-api-plugin/blob/v2.3.0/src/commands/api.ts)_\n\u003c!-- commandsstop --\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheroku%2Fheroku-api-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheroku%2Fheroku-api-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheroku%2Fheroku-api-plugin/lists"}