Upgrade Guidance

Get Upgrade Guidance

post

Get or generate version upgrade guidance.

Authorizations
Body
package_namestringRequired
package_managerstring · enumRequiredPossible values:
from_versionsstring[]Required
to_versionstringRequired
Responses
200
Successful Response
application/json
post
POST /api/upgrade-guidance/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "package_name": "text",
  "package_manager": "default",
  "from_versions": [
    "text"
  ],
  "to_version": "text"
}
{
  "id": 1,
  "guidance": "text",
  "generated_at": "2025-06-27T13:20:43.263Z"
}

Invalidate Upgrade Guidance

post

Get or generate version upgrade guidance.

Authorizations
Body
package_namestringRequired
package_managerstring · enumRequiredPossible values:
from_versionsstring[]Required
to_versionstringRequired
Responses
200
Successful Response
application/json
post
POST /api/upgrade-guidance/invalidate HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "package_name": "text",
  "package_manager": "default",
  "from_versions": [
    "text"
  ],
  "to_version": "text"
}
{
  "ok": true,
  "message": "text"
}

Was this helpful?