{"id":15296228,"url":"https://github.com/ftw-soft/rundeck-api-client","last_synced_at":"2025-10-07T08:31:02.305Z","repository":{"id":54509049,"uuid":"133711207","full_name":"ftw-soft/rundeck-api-client","owner":"ftw-soft","description":"PHP client for Rundeck v. 21+ API","archived":true,"fork":false,"pushed_at":"2021-02-14T19:34:16.000Z","size":41,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-23T23:49:45.896Z","etag":null,"topics":["api-client","library","php5","php7","rundeck","rundeck-cli"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/ftw-soft.png","metadata":{"files":{"readme":"README.md","changelog":null,"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-05-16T19:03:19.000Z","updated_at":"2023-10-09T09:15:46.000Z","dependencies_parsed_at":"2022-08-13T18:10:35.303Z","dependency_job_id":null,"html_url":"https://github.com/ftw-soft/rundeck-api-client","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/ftw-soft/rundeck-api-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ftw-soft%2Frundeck-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ftw-soft%2Frundeck-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ftw-soft%2Frundeck-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ftw-soft%2Frundeck-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ftw-soft","download_url":"https://codeload.github.com/ftw-soft/rundeck-api-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ftw-soft%2Frundeck-api-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278743020,"owners_count":26037953,"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","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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-client","library","php5","php7","rundeck","rundeck-cli"],"created_at":"2024-09-30T18:09:48.049Z","updated_at":"2025-10-07T08:31:01.749Z","avatar_url":"https://github.com/ftw-soft.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rundeck API client\n\nA php client to access the Rundeck API, based on the [official documentation](https://docs.rundeck.com/api/rundeck-api.html).\nNot all API functions are represented by default.\n\n## Requirements\n\n* PHP 7.2+ with enabled json extension\n* Rundeck 2.1+\n\nThis client is based on [PSR-17](https://www.php-fig.org/psr/psr-17/) and [PSR-18](https://www.php-fig.org/psr/psr-18/)\nand therefore you need a compatible HTTP client and request factories.\n\nWe suggest [Guzzle 7+](https://github.com/guzzle/guzzle) and [`http-interop/http-factory-guzzle`](https://github.com/http-interop/http-factory-guzzle):\n```bash\ncomposer require guzzlehttp/guzzle:^7.0 http-interop/http-factory-guzzle:^1.0\n```\n\n## Installation\n\n```bash\ncomposer require ftw-soft/rundeck-api-client\n```\n\n## Basic client usage\n\n```php\n\u003c?php\nrequire_once __DIR__ . '/vendor/autoload.php';\n\nuse FtwSoft\\Rundeck\\Authentication\\PasswordAuthentication;\nuse FtwSoft\\Rundeck\\Authentication\\TokenAuthentication;\nuse FtwSoft\\Rundeck\\Client;\nuse GuzzleHttp\\Client as HttpClient;\nuse Http\\Factory\\Guzzle\\RequestFactory;\nuse Http\\Factory\\Guzzle\\StreamFactory;\n\n$httpClient = new HttpClient();\n\n// --- Setup authentication ---\n# Password authentication\n$authentication = new PasswordAuthentication(\n    'https://rundeck.local',\n    'username',\n    'password',\n    $httpClient,\n    new RequestFactory(),\n    new StreamFactory()\n);\n\n# OR Token based authentication\n$authentication = new TokenAuthentication('secret-token');\n\n// --- Initialize client ---\n$client = new Client(\n    'https://rundeck.local',\n    $authentication,\n    $httpClient,\n    new RequestFactory(),\n    new StreamFactory(),\n    36 // optional API version\n);\n\n// Make a request\n$response = $client-\u003erequest('GET', 'projects');\nvar_dump($response-\u003egetBody()-\u003egetContents());\n```\n\n## Supported default scenarios\n\nThis package includes common request scenarios which are called \"resources\".\nThe following resources are currently supported:\n- Execution\n- Job\n- Project\n- Projects\n- System\n- Token\n- Tokens\n- User\n\nEach resource includes calls to the API and it's payload and/or response is represented by custom entity classes.\n\nFor example\n\n```php\n\u003c?php\nrequire_once __DIR__ . '/vendor/autoload.php';\n\nuse FtwSoft\\Rundeck\\Resource\\Tokens as TokensResource;\nuse FtwSoft\\Rundeck\\Client;\nuse FtwSoft\\Rundeck\\Entity\\TokenEntity;\n\n/** @var Client $client */\n$tokensResource = new TokensResource($client);\n\n/** @var TokenEntity[] $tokens */\n$tokens = $tokensResource-\u003eget();\n\nforeach ($tokens as $token) {\n    echo '====================================';\n    echo 'id: ', $token-\u003egetId(), PHP_EOL;\n    echo 'user:', $token-\u003egetUser(), PHP_EOL;\n    echo 'token: ', $token-\u003egetToken(), PHP_EOL;\n    echo 'creator: ', $token-\u003egetCreator(), PHP_EOL;\n    echo 'expire at: ', $token-\u003egetExpiration()-\u003eformat(\\DATE_ATOM), PHP_EOL;\n    echo 'roles: ', implode(', ', $token-\u003egetRoles()), PHP_EOL;\n    echo 'is expired: ', $token-\u003eisExpired() ? 'yes' : 'no', PHP_EOL;\n}\n```\n\nFeel free to add your own resources and entities to this package by creating a new [pull request](https://github.com/ftw-soft/rundeck-api-client/pulls).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fftw-soft%2Frundeck-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fftw-soft%2Frundeck-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fftw-soft%2Frundeck-api-client/lists"}