HomeGuidesAPI Reference
CommunityWebsiteDocumentationExchangeSupportDeveloper
API Reference

Initialize a System

Invokes the provider's full initialize lifecycle on a system that is in uninitialized
or failed status. This is the counterpart to POST /api/infrastructure/systems/uninitialized.

Any fields supplied in the request body are applied to the system before provider invocation.
Unlike normal PUT /api/infrastructure/systems/{id} updates, initialize does not use
authoritative omission-based component removal semantics.

Component matching behavior for components[] entries:

  1. Match by id — if a payload supplies an id, the component with that id is updated.
  2. Fallback to typeCode — if no id is supplied (or the id is not found), the system's
    existing components are searched by typeCode. The fallback only applies when exactly
    one
    existing component matches; if multiple components share the same typeCode the
    entry is skipped (ambiguous — supply id to disambiguate).
  3. New component creation — if no existing component matches and the typeCode is a valid
    component type code, a new component is created in uninitialized status.
  4. Unknown typeCode — if no existing component matches and the typeCode does not
    correspond to a known component type, the entry is silently skipped.

The initialize operation runs asynchronously via the provider plugin. On success the system
status transitions to ok. On failure it transitions to failed.

Requires full permission on infrastructure-system.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Morpheus ID of the Object being referenced

Body Params
system
object

Optional request body for initializing an existing uninitialized system.
All fields are optional — fields provided here are applied to the system before the
provider's initialize lifecycle is invoked. The system must currently be in
uninitialized or failed status.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json