IRPCExternalLocationsAdmin.RefreshExternalLocation
Administration API / specialized admin session idempotent
Checks the location now instead of waiting for the next automatic round.
| Service | External locations MFiles.IRPCExternalLocationsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCExternalLocationsAdmin/RefreshExternalLocation |
| HTTP (mf-http-grpc) | POST /grpc/v1/refresh-external-location |
| Request | RefreshExternalLocationRequest |
| Response | RefreshExternalLocationResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Tests access to the location first and fails if the location is disabled or cannot be reached.
- Starts the refresh as a background operation and returns once it has started, not when it has finished.
- Requires
manage_external_locations.
Request: RefreshExternalLocationRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
id | int32 | The ID of the external location to refresh. |
Response: RefreshExternalLocationResponse
No fields.