Update Project Metadata Settings
Command
Section titled “Command”php artisan uplinkr:project:updateDescription
Section titled “Description”Updates an existing project and its JSON-Data. This allows you to modify the label, description, and status (enabled/disabled) of a project without affecting its probes or historical data.
Options
Section titled “Options”| Option | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Name of the project to update |
--label | string | No | New project label/display name |
--description | string | No | New project description |
--status | string | No | Project status: enabled or disabled |
--force | flag | No | Force execution without confirmation |
Usage Examples
Section titled “Usage Examples”Update project label
Section titled “Update project label”php artisan uplinkr:project:update \ --project=my-project \ --label="My Website Production"Update project description
Section titled “Update project description”php artisan uplinkr:project:update \ --project=my-project \ --description="Production environment monitoring for main website"Update both label and description
Section titled “Update both label and description”php artisan uplinkr:project:update \ --project=my-project \ --label="My Website Production" \ --description="Production environment monitoring for main website"Enable a project
Section titled “Enable a project”php artisan uplinkr:project:update \ --project=my-project \ --status=enabledDisable a project
Section titled “Disable a project”php artisan uplinkr:project:update \ --project=my-project \ --status=disabledUpdate multiple attributes at once
Section titled “Update multiple attributes at once”php artisan uplinkr:project:update \ --project=my-project \ --label="My Website Production" \ --description="Production environment monitoring" \ --status=enabledForce mode (skip confirmation)
Section titled “Force mode (skip confirmation)”php artisan uplinkr:project:update \ --project=my-project \ --label="Updated Label" \ --forceBehavior
Section titled “Behavior”- Validates the project name
- Prompts for confirmation unless
--forceis used - Updates only the specified fields (label, description, and/or status)
- Preserves all other project settings and data
- Does not affect probe configurations or historical results
- Status can be set to
enabledordisabled
Use Cases
Section titled “Use Cases”- Update project display names for better organization
- Add or modify project descriptions for documentation
- Enable or disable projects without deleting them
- Maintain project metadata as services evolve
- Improve clarity in monitoring dashboards
Return Codes
Section titled “Return Codes”0(SUCCESS): Project updated successfully1(INVALID): Validation failed or process was aborted2(FAILURE): Failed to update the project