---
title: "Overview"
description: "Look up the Dark Pawns admin API request and response contract. Sign in with a level 40 character and use the authenticated admin console session."
type: reference
audience: operators
verified: v0.1.8
canonical: https://darkpawns.org/docs/reference/api/admin/
---

[Documentation](/docs/) / [Reference](/docs/reference/)

# Overview

Look up the Dark Pawns admin API request and response contract. Sign in with a level 40 character and use the authenticated admin console session.

## Dark Pawns admin API 1.0.0

Sign in through POST /admin/login with a level 40 implementor character. The admin console and API share the authenticated session. Read each operation for its request and response contract.

Information

*   OpenAPI version: `3.1.0`

## Operations

GET

[/admin/activity/events](/docs/reference/api/admin/operations/get-activity/)

GET

[/admin/agents](/docs/reference/api/admin/operations/list-agents/)

POST

[/admin/agents/status](/docs/reference/api/admin/operations/update-agent-status/)

GET

[/admin/characters](/docs/reference/api/admin/operations/list-saved-players/)

GET

[/admin/characters/{name}](/docs/reference/api/admin/operations/get-saved-player/)

PATCH

[/admin/characters/{name}](/docs/reference/api/admin/operations/edit-saved-player/)

POST

[/admin/characters/{name}/delete](/docs/reference/api/admin/operations/delete-saved-player/)

PATCH

[/admin/characters/{name}/flags](/docs/reference/api/admin/operations/edit-saved-player-flags/)

POST

[/admin/characters/{name}/items](/docs/reference/api/admin/operations/edit-saved-player-items/)

POST

[/admin/characters/{name}/password](/docs/reference/api/admin/operations/reset-saved-player-password/)

POST

[/admin/characters/{name}/rename](/docs/reference/api/admin/operations/rename-saved-player/)

GET

[/admin/dashboard](/docs/reference/api/admin/operations/get-dashboard/)

GET

[/admin/files/lua/resolve](/docs/reference/api/admin/operations/resolve-script-name/)

GET

[/admin/files/lua/usage](/docs/reference/api/admin/operations/get-script-usage/)

GET

[/admin/files/{root}/content](/docs/reference/api/admin/operations/get-editable-file/)

PUT

[/admin/files/{root}/content](/docs/reference/api/admin/operations/put-editable-file/)

DELETE

[/admin/files/{root}/content](/docs/reference/api/admin/operations/delete-editable-file/)

GET

[/admin/files/{root}/listing](/docs/reference/api/admin/operations/list-editable-files/)

GET

[/admin/findings](/docs/reference/api/admin/operations/list-findings/)

POST

[/admin/findings](/docs/reference/api/admin/operations/create-finding/)

PUT

[/admin/findings/{id}](/docs/reference/api/admin/operations/update-finding/)

GET

[/admin/logbook](/docs/reference/api/admin/operations/get-logbook/)

GET

[/admin/logbook/export](/docs/reference/api/admin/operations/export-logbook/)

POST

[/admin/login](/docs/reference/api/admin/operations/admin-login/)

POST

[/admin/logout](/docs/reference/api/admin/operations/admin-logout/)

GET

[/admin/logs](/docs/reference/api/admin/operations/list-log-lines/)

GET

[/admin/metrics](/docs/reference/api/admin/operations/get-server-metrics/)

GET

[/admin/mobs](/docs/reference/api/admin/operations/list-mob-prototypes/)

GET

[/admin/mobs/{vnum}](/docs/reference/api/admin/operations/get-mob-prototype/)

GET

[/admin/mudlog](/docs/reference/api/admin/operations/list-mudlog-events/)

GET

[/admin/mudlog/catalog](/docs/reference/api/admin/operations/mudlog-catalog/)

GET

[/admin/network](/docs/reference/api/admin/operations/get-network/)

PUT

[/admin/network](/docs/reference/api/admin/operations/put-network/)

POST

[/admin/network/apply](/docs/reference/api/admin/operations/post-network-apply/)

GET

[/admin/network/status](/docs/reference/api/admin/operations/get-network-status/)

GET

[/admin/notifications](/docs/reference/api/admin/operations/get-notifications/)

PUT

[/admin/notifications](/docs/reference/api/admin/operations/save-notifications/)

PUT

[/admin/notifications/{provider}/credentials](/docs/reference/api/admin/operations/replace-notification-credentials/)

DELETE

[/admin/notifications/{provider}/credentials](/docs/reference/api/admin/operations/remove-notification-credentials/)

POST

[/admin/notifications/{provider}/test](/docs/reference/api/admin/operations/test-notification/)

GET

[/admin/objects](/docs/reference/api/admin/operations/list-object-prototypes/)

GET

[/admin/objects/{vnum}](/docs/reference/api/admin/operations/get-object-prototype/)

GET

[/admin/olc/held](/docs/reference/api/admin/operations/list-olc-held/)

GET

[/admin/olc/lookup/{kind}/{vnum}/name](/docs/reference/api/admin/operations/lookup-olc-vnum/)

GET

[/admin/olc/pending](/docs/reference/api/admin/operations/list-olc-pending/)

POST

[/admin/olc/room/{vnum}](/docs/reference/api/admin/operations/open-olc-room-draft/)

GET

[/admin/olc/room/{vnum}/draft](/docs/reference/api/admin/operations/get-olc-room-draft/)

DELETE

[/admin/olc/room/{vnum}/draft](/docs/reference/api/admin/operations/discard-olc-room-draft/)

PATCH

[/admin/olc/room/{vnum}/draft](/docs/reference/api/admin/operations/patch-olc-room-draft/)

POST

[/admin/olc/room/{vnum}/draft/commit](/docs/reference/api/admin/operations/commit-olc-room-draft/)

GET

[/admin/olc/schema/{kind}](/docs/reference/api/admin/operations/get-olc-schema/)

POST

[/admin/olc/zones/{zone}](/docs/reference/api/admin/operations/create-olc-zone/)

POST

[/admin/olc/zones/{zone}/save](/docs/reference/api/admin/operations/save-olc-zone/)

GET

[/admin/olc/zones/{zone}/vnums](/docs/reference/api/admin/operations/get-olc-vnum-map/)

POST

[/admin/olc/{kind}/{vnum}](/docs/reference/api/admin/operations/open-olc-entity-draft/)

GET

[/admin/olc/{kind}/{vnum}/draft](/docs/reference/api/admin/operations/get-olc-entity-draft/)

DELETE

[/admin/olc/{kind}/{vnum}/draft](/docs/reference/api/admin/operations/discard-olc-entity-draft/)

PATCH

[/admin/olc/{kind}/{vnum}/draft](/docs/reference/api/admin/operations/patch-olc-entity-draft/)

POST

[/admin/olc/{kind}/{vnum}/draft/commit](/docs/reference/api/admin/operations/commit-olc-entity-draft/)

GET

[/admin/olc/{kind}/{vnum}/preview](/docs/reference/api/admin/operations/preview-olc-resource/)

GET

[/admin/players](/docs/reference/api/admin/operations/list-online-players/)

GET

[/admin/players/{name}](/docs/reference/api/admin/operations/get-player/)

POST

[/admin/players/{name}/kick](/docs/reference/api/admin/operations/kick-player/)

POST

[/admin/players/{name}/save](/docs/reference/api/admin/operations/save-player/)

POST

[/admin/reset-all-zones](/docs/reference/api/admin/operations/reset-all-zones/)

POST

[/admin/restart](/docs/reference/api/admin/operations/post-restart/)

GET

[/admin/rooms/{vnum}](/docs/reference/api/admin/operations/get-room/)

GET

[/admin/search](/docs/reference/api/admin/operations/search-world/)

GET

[/admin/server](/docs/reference/api/admin/operations/get-server-info/)

GET

[/admin/session](/docs/reference/api/admin/operations/admin-session/)

GET

[/admin/settings](/docs/reference/api/admin/operations/get-settings/)

PUT

[/admin/settings/access](/docs/reference/api/admin/operations/put-settings-access/)

GET

[/admin/settings/audit](/docs/reference/api/admin/operations/get-settings-audit/)

PUT

[/admin/settings/contact](/docs/reference/api/admin/operations/put-settings-contact/)

GET

[/admin/settings/export](/docs/reference/api/admin/operations/get-settings-export/)

PUT

[/admin/settings/grapevine](/docs/reference/api/admin/operations/put-settings-grapevine/)

POST

[/admin/settings/restore/apply](/docs/reference/api/admin/operations/post-settings-restore-apply/)

POST

[/admin/settings/restore/validate](/docs/reference/api/admin/operations/post-settings-restore-validate/)

PUT

[/admin/settings/sessions](/docs/reference/api/admin/operations/put-settings-sessions/)

PUT

[/admin/settings/staff\_push](/docs/reference/api/admin/operations/put-settings-staff-push/)

GET

[/admin/shops](/docs/reference/api/admin/operations/list-shops/)

GET

[/admin/shops/{keeper}](/docs/reference/api/admin/operations/get-shop/)

GET

[/admin/triage/summaries](/docs/reference/api/admin/operations/list-triage-summaries/)

POST

[/admin/triage/summaries](/docs/reference/api/admin/operations/create-triage-summary/)

POST

[/admin/updates/apply](/docs/reference/api/admin/operations/post-updates-apply/)

POST

[/admin/updates/check](/docs/reference/api/admin/operations/post-updates-check/)

GET

[/admin/updates/status](/docs/reference/api/admin/operations/get-updates-status/)

GET

[/admin/zones](/docs/reference/api/admin/operations/list-zones/)

POST

[/admin/zones/reset](/docs/reference/api/admin/operations/reset-zone-placeholder/)

GET

[/admin/zones/{number}](/docs/reference/api/admin/operations/get-zone/)

POST

[/admin/zones/{number}/reset](/docs/reference/api/admin/operations/reset-zone/)
