+215
-35
@@ -1,4 +1,48 @@
|
||||
basePath: /
|
||||
definitions:
|
||||
models.AuthLoginRequest:
|
||||
properties:
|
||||
password:
|
||||
type: string
|
||||
username:
|
||||
type: string
|
||||
type: object
|
||||
models.AuthLoginResponse:
|
||||
properties:
|
||||
access_token:
|
||||
type: string
|
||||
expires_at:
|
||||
type: integer
|
||||
token_type:
|
||||
type: string
|
||||
type: object
|
||||
models.AuthMeResponse:
|
||||
properties:
|
||||
audience:
|
||||
type: string
|
||||
expires_at:
|
||||
type: integer
|
||||
groups:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
issued_at:
|
||||
type: integer
|
||||
issuer:
|
||||
type: string
|
||||
not_before:
|
||||
type: integer
|
||||
roles:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
status:
|
||||
type: string
|
||||
subject:
|
||||
type: string
|
||||
token_id:
|
||||
type: string
|
||||
type: object
|
||||
models.CloudEventReceived:
|
||||
properties:
|
||||
cloudEvent:
|
||||
@@ -320,6 +364,9 @@ definitions:
|
||||
type: object
|
||||
info:
|
||||
contact: {}
|
||||
description: vCTP API endpoints for inventory snapshots, reporting, and administration.
|
||||
title: vCTP API
|
||||
version: "1.0"
|
||||
paths:
|
||||
/:
|
||||
get:
|
||||
@@ -338,11 +385,72 @@ paths:
|
||||
summary: Home page
|
||||
tags:
|
||||
- ui
|
||||
/api/auth/login:
|
||||
post:
|
||||
consumes:
|
||||
- application/json
|
||||
description: Authenticates a username/password against LDAP and returns a signed
|
||||
access token.
|
||||
parameters:
|
||||
- description: Login credentials
|
||||
in: body
|
||||
name: payload
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/models.AuthLoginRequest'
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
"200":
|
||||
description: Login success
|
||||
schema:
|
||||
$ref: '#/definitions/models.AuthLoginResponse'
|
||||
"400":
|
||||
description: Invalid request
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
"401":
|
||||
description: Invalid credentials
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
"500":
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
"503":
|
||||
description: Authentication disabled
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
summary: Login
|
||||
tags:
|
||||
- auth
|
||||
/api/auth/me:
|
||||
get:
|
||||
description: |-
|
||||
Returns JWT claims for the currently authenticated bearer token.
|
||||
Requires Bearer authentication.
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
"200":
|
||||
description: Authenticated identity
|
||||
schema:
|
||||
$ref: '#/definitions/models.AuthMeResponse'
|
||||
"401":
|
||||
description: Missing or invalid authentication context
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Who am I
|
||||
tags:
|
||||
- auth
|
||||
/api/cleanup/updates:
|
||||
delete:
|
||||
deprecated: true
|
||||
description: 'Deprecated: Removes update records that are no longer associated
|
||||
with a VM.'
|
||||
description: |-
|
||||
Deprecated: Removes update records that are no longer associated with a VM.
|
||||
Requires Bearer authentication with the admin role.
|
||||
produces:
|
||||
- text/plain
|
||||
responses:
|
||||
@@ -354,6 +462,8 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Cleanup updates (deprecated)
|
||||
tags:
|
||||
- maintenance
|
||||
@@ -384,8 +494,9 @@ paths:
|
||||
- maintenance
|
||||
/api/diagnostics/daily-creation:
|
||||
get:
|
||||
description: Returns counts of daily summary rows missing CreationTime and sample
|
||||
rows for the given date.
|
||||
description: |-
|
||||
Returns counts of daily summary rows missing CreationTime and sample rows for the given date.
|
||||
Requires Bearer authentication with the viewer role (admin also allowed).
|
||||
parameters:
|
||||
- description: Daily date (YYYY-MM-DD)
|
||||
in: query
|
||||
@@ -411,6 +522,8 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Daily summary CreationTime diagnostics
|
||||
tags:
|
||||
- diagnostics
|
||||
@@ -418,7 +531,9 @@ paths:
|
||||
post:
|
||||
consumes:
|
||||
- application/json
|
||||
description: Encrypts a plaintext value and returns the ciphertext.
|
||||
description: |-
|
||||
Encrypts a plaintext value and returns the ciphertext.
|
||||
Requires Bearer authentication with the admin role.
|
||||
parameters:
|
||||
- description: Plaintext payload
|
||||
in: body
|
||||
@@ -443,6 +558,8 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Encrypt data
|
||||
tags:
|
||||
- crypto
|
||||
@@ -451,8 +568,9 @@ paths:
|
||||
consumes:
|
||||
- application/json
|
||||
deprecated: true
|
||||
description: 'Deprecated: Parses a VM create CloudEvent and stores the event
|
||||
data.'
|
||||
description: |-
|
||||
Deprecated: Parses a VM create CloudEvent and stores the event data.
|
||||
Requires Bearer authentication with the admin role.
|
||||
parameters:
|
||||
- description: CloudEvent payload
|
||||
in: body
|
||||
@@ -475,6 +593,8 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Record VM create event (deprecated)
|
||||
tags:
|
||||
- events
|
||||
@@ -483,8 +603,9 @@ paths:
|
||||
consumes:
|
||||
- application/json
|
||||
deprecated: true
|
||||
description: 'Deprecated: Parses a VM delete CloudEvent and marks the VM as
|
||||
deleted in inventory.'
|
||||
description: |-
|
||||
Deprecated: Parses a VM delete CloudEvent and marks the VM as deleted in inventory.
|
||||
Requires Bearer authentication with the admin role.
|
||||
parameters:
|
||||
- description: CloudEvent payload
|
||||
in: body
|
||||
@@ -507,6 +628,8 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Record VM delete event (deprecated)
|
||||
tags:
|
||||
- events
|
||||
@@ -515,8 +638,9 @@ paths:
|
||||
consumes:
|
||||
- application/json
|
||||
deprecated: true
|
||||
description: 'Deprecated: Parses a VM modify CloudEvent and creates an update
|
||||
record when relevant changes are detected.'
|
||||
description: |-
|
||||
Deprecated: Parses a VM modify CloudEvent and creates an update record when relevant changes are detected.
|
||||
Requires Bearer authentication with the admin role.
|
||||
parameters:
|
||||
- description: CloudEvent payload
|
||||
in: body
|
||||
@@ -539,6 +663,8 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Record VM modify event (deprecated)
|
||||
tags:
|
||||
- events
|
||||
@@ -547,8 +673,9 @@ paths:
|
||||
consumes:
|
||||
- application/json
|
||||
deprecated: true
|
||||
description: 'Deprecated: Parses a VM move CloudEvent and creates an update
|
||||
record.'
|
||||
description: |-
|
||||
Deprecated: Parses a VM move CloudEvent and creates an update record.
|
||||
Requires Bearer authentication with the admin role.
|
||||
parameters:
|
||||
- description: CloudEvent payload
|
||||
in: body
|
||||
@@ -571,6 +698,8 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Record VM move event (deprecated)
|
||||
tags:
|
||||
- events
|
||||
@@ -579,7 +708,9 @@ paths:
|
||||
consumes:
|
||||
- application/json
|
||||
deprecated: true
|
||||
description: 'Deprecated: Imports existing VM inventory data in bulk.'
|
||||
description: |-
|
||||
Deprecated: Imports existing VM inventory data in bulk.
|
||||
Requires Bearer authentication with the admin role.
|
||||
parameters:
|
||||
- description: Bulk import payload
|
||||
in: body
|
||||
@@ -598,14 +729,17 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Import VMs (deprecated)
|
||||
tags:
|
||||
- inventory
|
||||
/api/inventory/vm/delete:
|
||||
delete:
|
||||
deprecated: true
|
||||
description: 'Deprecated: Removes a VM inventory entry by VM ID and datacenter
|
||||
name.'
|
||||
description: |-
|
||||
Deprecated: Removes a VM inventory entry by VM ID and datacenter name.
|
||||
Requires Bearer authentication with the admin role.
|
||||
parameters:
|
||||
- description: VM ID
|
||||
in: query
|
||||
@@ -628,14 +762,17 @@ paths:
|
||||
description: Invalid request
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Cleanup VM inventory entry (deprecated)
|
||||
tags:
|
||||
- inventory
|
||||
/api/inventory/vm/update:
|
||||
post:
|
||||
deprecated: true
|
||||
description: 'Deprecated: Queries vCenter and updates inventory records with
|
||||
missing details.'
|
||||
description: |-
|
||||
Deprecated: Queries vCenter and updates inventory records with missing details.
|
||||
Requires Bearer authentication with the admin role.
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
@@ -647,12 +784,16 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Refresh VM details (deprecated)
|
||||
tags:
|
||||
- inventory
|
||||
/api/report/inventory:
|
||||
get:
|
||||
description: Generates an inventory XLSX report and returns it as a file download.
|
||||
description: |-
|
||||
Generates an inventory XLSX report and returns it as a file download.
|
||||
Requires Bearer authentication with the viewer role (admin also allowed).
|
||||
produces:
|
||||
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
|
||||
responses:
|
||||
@@ -664,12 +805,16 @@ paths:
|
||||
description: Report generation failed
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Download inventory report
|
||||
tags:
|
||||
- reports
|
||||
/api/report/snapshot:
|
||||
get:
|
||||
description: Downloads a snapshot table as an XLSX file.
|
||||
description: |-
|
||||
Downloads a snapshot table as an XLSX file.
|
||||
Requires Bearer authentication with the viewer role (admin also allowed).
|
||||
parameters:
|
||||
- description: Snapshot table name
|
||||
in: query
|
||||
@@ -691,12 +836,16 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Download snapshot report
|
||||
tags:
|
||||
- snapshots
|
||||
/api/report/updates:
|
||||
get:
|
||||
description: Generates an updates XLSX report and returns it as a file download.
|
||||
description: |-
|
||||
Generates an updates XLSX report and returns it as a file download.
|
||||
Requires Bearer authentication with the viewer role (admin also allowed).
|
||||
produces:
|
||||
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
|
||||
responses:
|
||||
@@ -708,13 +857,16 @@ paths:
|
||||
description: Report generation failed
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Download updates report
|
||||
tags:
|
||||
- reports
|
||||
/api/snapshots/aggregate:
|
||||
post:
|
||||
description: Forces regeneration of a daily or monthly summary table for a specified
|
||||
date or month.
|
||||
description: |-
|
||||
Forces regeneration of a daily or monthly summary table for a specified date or month.
|
||||
Requires Bearer authentication with the admin role.
|
||||
parameters:
|
||||
- description: 'Aggregation type: daily or monthly'
|
||||
in: query
|
||||
@@ -745,6 +897,8 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Force snapshot aggregation
|
||||
tags:
|
||||
- snapshots
|
||||
@@ -752,8 +906,9 @@ paths:
|
||||
post:
|
||||
consumes:
|
||||
- application/json
|
||||
description: Manually trigger an hourly snapshot for all configured vCenters.
|
||||
Requires confirmation text to avoid accidental execution.
|
||||
description: |-
|
||||
Manually trigger an hourly snapshot for all configured vCenters. Requires confirmation text to avoid accidental execution.
|
||||
Requires Bearer authentication with the admin role.
|
||||
parameters:
|
||||
- description: Confirmation text; must be 'FORCE'
|
||||
in: query
|
||||
@@ -775,13 +930,16 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Trigger hourly snapshot (manual)
|
||||
tags:
|
||||
- snapshots
|
||||
/api/snapshots/migrate:
|
||||
post:
|
||||
description: Rebuilds the snapshot registry from existing tables and renames
|
||||
hourly tables to epoch-based names.
|
||||
description: |-
|
||||
Rebuilds the snapshot registry from existing tables and renames hourly tables to epoch-based names.
|
||||
Requires Bearer authentication with the admin role.
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
@@ -793,13 +951,16 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.SnapshotMigrationResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Migrate snapshot registry
|
||||
tags:
|
||||
- snapshots
|
||||
/api/snapshots/regenerate-hourly-reports:
|
||||
post:
|
||||
description: Regenerates XLSX reports for hourly snapshots when the report files
|
||||
are missing or empty.
|
||||
description: |-
|
||||
Regenerates XLSX reports for hourly snapshots when the report files are missing or empty.
|
||||
Requires Bearer authentication with the admin role.
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
@@ -811,13 +972,16 @@ paths:
|
||||
description: Server error
|
||||
schema:
|
||||
$ref: '#/definitions/models.ErrorResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Regenerate hourly snapshot reports
|
||||
tags:
|
||||
- snapshots
|
||||
/api/snapshots/repair:
|
||||
post:
|
||||
description: Backfills SnapshotTime and lifecycle info for existing daily summary
|
||||
tables and reruns monthly lifecycle refinement using hourly data.
|
||||
description: |-
|
||||
Backfills SnapshotTime and lifecycle info for existing daily summary tables and reruns monthly lifecycle refinement using hourly data.
|
||||
Requires Bearer authentication with the admin role.
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
@@ -825,13 +989,16 @@ paths:
|
||||
description: OK
|
||||
schema:
|
||||
$ref: '#/definitions/models.SnapshotRepairResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Repair daily summaries
|
||||
tags:
|
||||
- snapshots
|
||||
/api/snapshots/repair/all:
|
||||
post:
|
||||
description: Rebuilds snapshot registry, backfills per-vCenter totals, repairs
|
||||
daily summaries (SnapshotTime/lifecycle), and refines monthly lifecycle.
|
||||
description: |-
|
||||
Rebuilds snapshot registry, backfills per-vCenter totals, repairs daily summaries (SnapshotTime/lifecycle), and refines monthly lifecycle.
|
||||
Requires Bearer authentication with the admin role.
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
@@ -839,13 +1006,16 @@ paths:
|
||||
description: OK
|
||||
schema:
|
||||
$ref: '#/definitions/models.SnapshotRepairSuiteResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Run full snapshot repair suite
|
||||
tags:
|
||||
- snapshots
|
||||
/api/vcenters/cache/rebuild:
|
||||
post:
|
||||
description: Rebuilds cached folder/resource-pool/host(cluster+datacenter) references
|
||||
from vCenter and rewrites the database cache tables.
|
||||
description: |-
|
||||
Rebuilds cached folder/resource-pool/host(cluster+datacenter) references from vCenter and rewrites the database cache tables.
|
||||
Requires Bearer authentication with the admin role.
|
||||
parameters:
|
||||
- description: Optional single vCenter URL to rebuild; defaults to all configured
|
||||
vCenters
|
||||
@@ -871,6 +1041,8 @@ paths:
|
||||
description: All rebuild attempts failed
|
||||
schema:
|
||||
$ref: '#/definitions/models.VcenterCacheRebuildResponse'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
summary: Rebuild vCenter object cache
|
||||
tags:
|
||||
- vcenters
|
||||
@@ -1069,4 +1241,12 @@ paths:
|
||||
summary: Trace VM history
|
||||
tags:
|
||||
- vm
|
||||
schemes:
|
||||
- http
|
||||
- https
|
||||
securityDefinitions:
|
||||
BearerAuth:
|
||||
in: header
|
||||
name: Authorization
|
||||
type: apiKey
|
||||
swagger: "2.0"
|
||||
|
||||
Reference in New Issue
Block a user