{"id":45187983,"url":"https://github.com/cycleplatform/api-client-nodejs","last_synced_at":"2026-02-20T11:05:45.244Z","repository":{"id":41777106,"uuid":"143581353","full_name":"cycleplatform/api-client-nodejs","owner":"cycleplatform","description":"Cycle API Library for NodeJS","archived":false,"fork":false,"pushed_at":"2023-03-04T02:46:48.000Z","size":5203,"stargazers_count":9,"open_issues_count":9,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-26T09:15:56.002Z","etag":null,"topics":["api","containers","cycle","cycle-io","nodejs"],"latest_commit_sha":null,"homepage":"https://cycle.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cycleplatform.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-05T03:51:30.000Z","updated_at":"2022-08-09T19:42:59.000Z","dependencies_parsed_at":"2023-02-18T15:46:08.972Z","dependency_job_id":null,"html_url":"https://github.com/cycleplatform/api-client-nodejs","commit_stats":null,"previous_names":[],"tags_count":461,"template":false,"template_full_name":null,"purl":"pkg:github/cycleplatform/api-client-nodejs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycleplatform%2Fapi-client-nodejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycleplatform%2Fapi-client-nodejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycleplatform%2Fapi-client-nodejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycleplatform%2Fapi-client-nodejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cycleplatform","download_url":"https://codeload.github.com/cycleplatform/api-client-nodejs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycleplatform%2Fapi-client-nodejs/sbom","scorecard":{"id":314280,"data":{"date":"2025-08-11","repo":{"name":"github.com/cycleplatform/api-client-nodejs","commit":"dfc789a8d4eff1248b504835bdba13aea47b72c4"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.6,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":2,"reason":"Found 2/7 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'","Warn: branch protection not enabled for branch 'dev'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 25 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"38 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-px4h-xg32-q955","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T23:51:07.769Z","repository_id":41777106,"created_at":"2025-08-17T23:51:07.769Z","updated_at":"2025-08-17T23:51:07.769Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29648541,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-20T09:27:29.698Z","status":"ssl_error","status_checked_at":"2026-02-20T09:26:12.373Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","containers","cycle","cycle-io","nodejs"],"created_at":"2026-02-20T11:05:44.517Z","updated_at":"2026-02-20T11:05:45.238Z","avatar_url":"https://github.com/cycleplatform.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cycle API Client For NodeJS\n\nSeeking to extend the platform's functionalities? Tie into this REST-based API client and interact programmatically based on your application's needs.\n\nFor detailed documentation, please see the official [Cycle API Docs](https://docs.cycle.io/api/introduction)\n\n## Details\n\nSeeking to extend the platform's functionalities? Tie into this REST-based API client and interact programmatically based on your application's needs.\n\nAll requests follow this format:\n\n```bash\n   curl https://api.cycle.io/v1/\u003cresource\u003e \\\n    -H \"Authorization: Bearer API_KEY\" \\\n    -H \"X-Hub-Id=HUB_ID\"\n```\n\nAll API responses are returned as JSON. There is also support for cross-origin resource sharing, meaning this API can be used in a client-side web application as well.\n\n# Requirements\n\n- Active account on the [Cycle Platform](https://portal.cycle.io)\n- Active hub with [infrastructure provider(s)](https://docs.cycle.io/infrastructure/providers/adding-providers/) added to take advantage of full API\n- Generated [API key](https://docs.cycle.io/hubs/api-access/generating-api-keys/)\n\n### NPM\n\n`npm install @cycleplatform/cycle-api`\n\n### Yarn\n\n`yarn add @cycleplatform/cycle-api`\n\n## Usage\n\nUsing node client with TypeScript to create a new environment.\n\n**Request:**\n\nTo perform this request [environment-create permissions](https://docs.cycle.io/hubs/members-permissions/roles-and-permissions/) are necessary.\n\n```typescript\nimport { Environments } from \"@cycleplatform/cycle-api\";\n\n/* This is a visualization of the partial response object\n * you receive when creating an Environment. Full response\n * type is avaliable as `Environments.Environment` and can be found here\n*/\ntype EnvironmentT = {\n  id: string;\n  name: string;\n  cluster: string;\n  about?: {\n    description: string;\n    favorite: boolean;\n  };\n  ...\n};\n\nasync function createEnv() {\n  const response: Environments.Environment = Environments.create({\n    // sensative keys should always be stored and an env variable\n    token: process.env.CYCLE_API_KEY,\n    hubId: process.env.HUB_ID,\n    value: {\n      name: \"My New Environment\",\n      cluster: \"production\",\n      // About is an optional field\n      about: {\n        description: \"Test environment\"\n      },\n      features: {\n       legacy_networking: false,\n      },\n      // Stacks is an optional field\n      stack: {\n        // replace with stack id\n        id: STACK_ID,\n        // replace with build id\n        build_id: BUILD_ID\n      }\n    }\n  });\n\n  if (!response.ok) {\n    // Do something with the error\n    console.log(response);\n    return;\n  }\n\n  // Do something with successful reponse\n  console.log(response);\n  return;\n}\n\ncreateEnv();\n```\n\n**Successful Response:**\n\nThis response has been truncated. To view the full response of creating an environment, please click [here](https://docs.cycle.io/api/environments/the-environment-resource).\n\n```json\n// console.log(response)\n{\n  \"ok\": true,\n  \"error\": {},\n  \"value\": {\n    \"data\": {\n      \"id\" : \"5cec602e4146380001934759\",\n      \"name\": \"My New Environment\",\n      \"about\" : {\n        \"description\": \"Test environment\",\n        \"favorite\": false,\n      },\n      \"cluster\":  \"prodction\",\n      ...\n    }\n  }\n}\n```\n\n**Failed Response:**\n\nAll failed API requests follow the same error response format. To view more details about the error response object, please click [here](https://docs.cycle.io/api/basics/errors).\n\n```json\n// console.log(response)\n// This error would be given if the cluster does not exist\n{\n  \"ok\": false,\n  \"error\": {\n    \"status\": 422,\n    \"code\": \"422.invalid_input\",\n    \"title\": \"Cluster is not valid\"\n  },\n  \"value\": {}\n}\n```\n\n**Error Response Codes:**\n\n\u003cdetails\u003e\n\u003csummary\u003eCycle Specific Network Errors — 0's\u003c/summary\u003e\n\n- 0.network_error\n- 0.parse_error\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eClient Error Responses — 400's\u003c/summary\u003e\n\n- 400.invalid_syntax\n- 401.auth_invalid\n- 401.auth_expired\n- 401.no_cookie\n- 401.unauthorized_application\n- 403.mismatch\n- 403.not_ready\n- 403.expired\n- 403.restricted_portal\n- 403.permissions\n- 403.invalid_ip\n- 403.invalid_state\n- 403.not_approved\n- 403.not_allowed\n- 403.2fa_required\n- 403.2fa_failed\n- 403.new_application_capabilities\n- 403.tier_restricted\n- 404.hub\n- 404.hub.invitation\n- 404.sdn_network\n- 404.environment\n- 404.hub.api_key\n- 404.uri\n- 404.provider\n- 404.stack\n- 404.notification\n- 404.stack_build\n- 404.stack_hook\n- 404.image\n- 404.job\n- 404.order\n- 404.billing_service\n- 404.billing_credit\n- 404.invoice\n- 404.node\n- 404.infrastructure_location\n- 404.infrastructure_ip\n- 404.infrastructure_server\n- 404.infrastructure_model\n- 404.account\n- 404.container\n- 404.vpn_account\n- 404.instance\n- 404.dns_zone\n- 404.dns_record\n- 404.cluster\n- 404.email_verification\n- 404.promo_code\n- 404.billing.tier\n- 404.payment_method\n- 404.hub.membership\n- 404.announcement\n- 404.ha_service_session\n- 409.duplicate_found\n- 415.invalid_content_type\n- 422.missing_argument\n- 422.invalid_argument\n- 422.invalid_input\n- 422.not_compatible\n- 422.already_exists\n- 429.rate_limiting\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eInternal Error Responses — 500's\u003c/summary\u003e\n\n- 500.database\n- 500.database_insert\n- 500.database_update\n- 500.database_remove\n- 500.jobd\n- 500.unknown\n- 500.email\n- 500.payment_gateway\n- 503.not_ready\n- 503.not_enabled\n- 503.dependency_not_enabled\n\n\u003c/details\u003e\n\n## Contributing\n\nWe accept issues and PRs from the community! Any and all feedback is greatly appreciated. The public repository can be found here.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcycleplatform%2Fapi-client-nodejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcycleplatform%2Fapi-client-nodejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcycleplatform%2Fapi-client-nodejs/lists"}