Download the PHP package codysseydev/argus-api without Composer

On this page you can find all versions of the php package codysseydev/argus-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package argus-api

Argus API (codysseydev/argus-api)

Packagist Version Packagist Downloads Tests

A JSON HTTP API over the codysseydev/argus queue-observability core. It exposes the core's read and management services and nothing else: it holds no storage knowledge, emits no SQL, and never touches a database. Dependency direction is one way: React client -> this API -> codysseydev/argus -> storage.

Installation

Optionally publish an editable authorization provider:

Authentication and authorization

Envelope

Success:

Error:

Lists are always arrays; an empty result is data: [] with 200.

Endpoints

Full reference: docs/api.md.

All paths are relative to the configured prefix (default argus-api).

POST /search (gate: view-jobs)

Body: a filter object (see Filter below). Returns current-state jobs.

GET /jobs/{jobUuid}/history (gate: view-jobs)

Ordered lifecycle of one job. Unknown uuid → 404.

POST /failures (gate: view-failures)

Body: a filter object. Returns failures grouped by exception fingerprint.

Saved searches (gate: manage-saved-searches; results is view-jobs)

Method Path Body Returns
GET /saved-searches — { data: SavedSearch[], meta: { count } }
POST /saved-searches { name, filter } 201 { data: SavedSearch }
GET /saved-searches/{id} — { data: SavedSearch } (404 if unknown)
PUT /saved-searches/{id} { name, filter } { data: SavedSearch }
DELETE /saved-searches/{id} — 204
GET /saved-searches/{id}/results — { data: JobSummary[], meta: { savedSearchId, count } }

Alert rules (gate: manage-alerts)

Method Path Body Returns
GET /saved-searches/{id}/alert-rules — { data: AlertRule[], meta: { savedSearchId, count } }
POST /saved-searches/{id}/alert-rules rule body 201 { data: AlertRule } (404 if saved search unknown)
GET /alert-rules — { data: AlertRule[], meta: { count } }
GET /alert-rules/{id} — { data: AlertRule } (404 if unknown)
PUT /alert-rules/{id} rule body { data: AlertRule }
DELETE /alert-rules/{id} — 204

Rule body: { name, threshold, windowSeconds, cooldownSeconds, sinks: string[], enabled?: boolean }.

Status codes

200 reads/updates · 201 create · 204 delete · 403 gate denial · 404 unknown id/uuid · 422 validation.

TypeScript contract (Phase 5)

Development

Tests use in-memory fakes for all storage contracts, so no database is required. A running Redis is required because ArgusServiceProvider opens a Redis buffer connection at boot.

To develop against an unreleased local checkout of the core, wire a path repository temporarily (do not commit this change):

See RELEASING.md for full details. Related packages: codysseydev/argus (core), codysseydev/argus-ui (React UI).

All versions of argus-api with dependencies

PHP Build Version
Package Version
Requires php Version ^8.5
codysseydev/argus Version ^0.1
illuminate/contracts Version ^12.0 || ^13.0
illuminate/http Version ^12.0 || ^13.0
illuminate/routing Version ^12.0 || ^13.0
illuminate/support Version ^12.0 || ^13.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package codysseydev/argus-api contains the following files

Loading the files please wait ...