The P4 REST API offers a web-accessible interface to the P4 Server, enabling developers to create scripts and applications that integrate with P4, streamline workflows, and extend its capabilities.
\nThe P4 REST API is a Technology Preview feature introduced with the 2025.2 release of P4 Server. Features offered in Technology Preview are experimental and not guaranteed to always work as expected. If you have feedback and functionality suggestions, email techpreview@perforce.com.
\nThe P4 REST API is actively evolving, and its behavior may change as we incorporate feedback. We encourage you to explore and experiment with the API, but be aware that updates are likely as it progresses toward a stable release. You may need to adjust your implementation over time.
\nWe plan to incorporate modern authentication in the P4 REST API in future releases. For this technical preview, users are responsible for acquiring their own P4 tickets and including them in their REST API requests.
\nTo obtain a P4 ticket that can be used for authenticated methods in the REST API, the ticket must be generated for a host named restapi. You can do this using the following command:
\n\n\n
p4 login -h restapi -p username
This command will return a ticket, which should be assigned to the TICKET collection variable.
If you are developing your own application and not using Postman, the ticket must be supplied via Basic Authentication. In this case, use your P4 username as the username, and the ticket you received as the password.
\nWebsite: https://portal.perforce.com/s/\nEmail: support@perforce.com
\nContact Support:\n Name: Perforce Software Support\n Email: support@perforce.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"About the REST API","slug":"about-the-rest-api"},{"content":"Authentication","slug":"authentication"},{"content":"Support","slug":"support"}],"owner":"47965326","collectionId":"5bb6ae96-ea41-4744-a3f3-474e7d8f894a","publishedId":"2sB3QRoSmm","public":true,"customColor":{"top-bar":"F6F9FD","right-sidebar":"303030","highlight":"4C00FF"},"publishDate":"2026-02-05T15:26:35.000Z"},"item":[{"name":"/api","item":[{"name":"/version","id":"6ef1ebce-8fb2-4527-89c4-bb518860f351","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/api/version","description":"Get the P4 Server version.
\n","urlObject":{"path":["version"],"host":["/api"],"query":[],"variable":[]}},"response":[{"id":"960eab1a-1fd7-4eab-9382-0087d5b1500b","name":"version","originalRequest":{"method":"GET","header":[{"description":"Correlates HTTP requests between the client and server. If not provided, a unique value is assigned to every request. The correlation ID used for a request is returned with the response. If this value is provided by the client application, it should be a unique value that distinguishes this request uniquely in the log messages.","key":"x-correlation-id","value":"9m4e2mr0ui3e8a215n4g","disabled":true},{"key":"Accept","value":"application/json"}],"url":"/api/version"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":true,"description":{"content":"","type":"text/plain"},"key":"x-correlation-id","value":""},{"disabled":true,"description":{"content":"","type":"text/plain"},"key":"cache-control","value":""},{"disabled":true,"description":{"content":"","type":"text/plain"},"key":"content-security-policy","value":""},{"disabled":true,"description":{"content":"","type":"text/plain"},"key":"x-content-type-options","value":""},{"disabled":true,"description":{"content":"","type":"text/plain"},"key":"x-frame-options","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"P4D/NTX64/2025.2.main/2800059\"\n}"}],"_postman_id":"6ef1ebce-8fb2-4527-89c4-bb518860f351"}],"id":"486f7980-2273-47e4-9d0f-07842a06f851","description":"P4 REST API endpoints that are not versioned
\n","_postman_id":"486f7980-2273-47e4-9d0f-07842a06f851"},{"name":"/api/v0","item":[{"name":"/v0/server/info","id":"5a5531e7-9a25-4987-ab8f-c9103b9b0066","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"bruno"},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/api/v0/server/info","description":"Get a list of information about the P4 Server.
\n","urlObject":{"path":["v0","server","info"],"host":["/api"],"query":[],"variable":[]}},"response":[{"id":"2036c48b-5731-4eb2-a93c-1c7519b5792f","name":"200 - server/info","originalRequest":{"method":"GET","header":[{"description":"Correlates HTTP requests between the client and server. If not provided, a unique value is assigned to every request. The correlation ID used for a request is returned with the response. If this value is provided by the client application, it should be a unique value that distinguishes this request uniquely in the log messages.","key":"x-correlation-id","value":"9m4e2mr0ui3e8a215n4g","disabled":true},{"description":"Specify the command group used to identify this command in the logs. If omitted, a UUID is generated and used automatically.","key":"x-p4d-command-group","value":"custom-command-group","disabled":true},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicGet a list of all depots defined on the server.
\n","urlObject":{"path":["v0","depot"],"host":["/api"],"query":[{"disabled":true,"description":{"content":"Filter the list to depots with a name that matches the filter pattern. If the server is running in case sensitive mode, the filter is case sensitive.
\n","type":"text/plain"},"key":"filter","value":"depo*"},{"disabled":true,"description":{"content":"List depots with a name that matches the pattern. If the server is running in case sensitive mode, this filter searches in a case insensitive manner.
\n","type":"text/plain"},"key":"ciFilter","value":"depo*"},{"disabled":true,"description":{"content":"Filter the response to only include depots of the specified type
\n","type":"text/plain"},"key":"type","value":"graph"}],"variable":[]}},"response":[{"id":"869e0552-c722-4774-905d-1c201c483f09","name":"200 - GET /depot","originalRequest":{"method":"GET","header":[{"description":"Correlates HTTP requests between the client and server. If not provided, a unique value is assigned to every request. The correlation ID used for a request is returned with the response. If this value is provided by the client application, it should be a unique value that distinguishes this request uniquely in the log messages.","key":"x-correlation-id","value":"9m4e2mr0ui3e8a215n4g","disabled":true},{"description":"Specify the command group used to identify this command in the logs. If omitted, a UUID is generated and used automatically.","key":"x-p4d-command-group","value":"custom-command-group","disabled":true},{"key":"Accept","value":"application/jsonl"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicDownload a file from a depot.
\n","urlObject":{"path":["v0","file","contents"],"host":["/api"],"query":[{"description":{"content":"File Specification in depot syntax. Wildcards are not allowed. Revision specifiers are allowed.
\n","type":"text/plain"},"key":"fileSpec","value":"//depot/path/to/file/file.txt"}],"variable":[]}},"response":[{"id":"3fea9e48-8927-456d-98c0-6c1aa78b9a01","name":"200 - File Download","originalRequest":{"method":"GET","header":[{"description":"Correlates HTTP requests between the client and server. If not provided, a unique value is assigned to every request. The correlation ID used for a request is returned with the response. If this value is provided by the client application, it should be a unique value that distinguishes this request uniquely in the log messages.","key":"x-correlation-id","value":"9m4e2mr0ui3e8a215n4g","disabled":true},{"description":"Specify the command group used to identify this command in the logs. If omitted, a UUID is generated and used automatically.","key":"x-p4d-command-group","value":"custom-command-group","disabled":true},{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicGet a list of details about specified revisions.
\n","urlObject":{"path":["v0","file","revisions"],"host":["/api"],"query":[{"description":{"content":"Comma-separated list of file specifications in depot syntax. Wildcards and revision specifiers are allowed. Each file spec must start with \"//\"
\n","type":"text/plain"},"key":"fileSpecs","value":"//depot/path/on/server/*,//depot/other/path/to/file.txt"},{"disabled":true,"description":{"content":"Maximum number of results to return
\n","type":"text/plain"},"key":"max","value":"7960"}],"variable":[]}},"response":[{"id":"e3ceef98-ec6b-43ad-8204-7a4c2dcdf534","name":"200 - file/revisions","originalRequest":{"method":"GET","header":[{"description":"Correlates HTTP requests between the client and server. If not provided, a unique value is assigned to every request. The correlation ID used for a request is returned with the response. If this value is provided by the client application, it should be a unique value that distinguishes this request uniquely in the log messages.","key":"x-correlation-id","value":"9m4e2mr0ui3e8a215n4g","disabled":true},{"description":"Specify the command group used to identify this command in the logs. If omitted, a UUID is generated and used automatically.","key":"x-p4d-command-group","value":"custom-command-group","disabled":true},{"key":"Accept","value":"application/jsonl"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicGet information about a specified changelist.
\n","urlObject":{"path":["v0","changelist",":changelistNum"],"host":["/api"],"query":[],"variable":[{"description":{"content":"Changelist number
\n","type":"text/plain"},"type":"any","value":"1","key":"changelistNum"}]}},"response":[{"id":"939a9ded-afc3-4176-a682-b8ec59082697","name":"200 - changelist/{change}","originalRequest":{"method":"GET","header":[{"description":"Correlates HTTP requests between the client and server. If not provided, a unique value is assigned to every request. The correlation ID used for a request is returned with the response. If this value is provided by the client application, it should be a unique value that distinguishes this request uniquely in the log messages.","key":"x-correlation-id","value":"9m4e2mr0ui3e8a215n4g","disabled":true},{"description":"Specify the command group used to identify this command in the logs. If omitted, a UUID is generated and used automatically.","key":"x-p4d-command-group","value":"custom-command-group","disabled":true},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicGet a list of revisions in a specified committed changelist.
\n","urlObject":{"path":["v0","changelist",":changelistNum","revisions"],"host":["/api"],"query":[{"disabled":true,"description":{"content":"Maximum number of results to return
\n","type":"text/plain"},"key":"max","value":"7960"}],"variable":[{"id":"bdc42f38-b889-4f4c-b414-c6748fea47bc","description":{"content":"Changelist number
\n","type":"text/plain"},"type":"any","value":"1","key":"changelistNum"}]}},"response":[{"id":"2b2153ba-5d61-48d7-bb8a-71583df2dcbe","name":"200 - changelist/{changelistNum}/revisions","originalRequest":{"method":"GET","header":[{"description":"Correlates HTTP requests between the client and server. If not provided, a unique value is assigned to every request. The correlation ID used for a request is returned with the response. If this value is provided by the client application, it should be a unique value that distinguishes this request uniquely in the log messages.","key":"x-correlation-id","value":"9m4e2mr0ui3e8a215n4g","disabled":true},{"description":"Specify the command group used to identify this command in the logs. If omitted, a UUID is generated and used automatically.","key":"x-p4d-command-group","value":"custom-command-group","disabled":true},{"key":"Accept","value":"application/jsonl"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicP4 REST API technical preview endpoints
\n","_postman_id":"b71c961d-b940-41f1-a685-cceed39f7284"}],"event":[{"listen":"prerequest","script":{"id":"5fa8d0d8-d4fd-45a4-8e3b-cc1c6acb12b5","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"5d630ffc-cc00-43b7-b33b-3e21766a36c8","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"/api","type":"any","description":"P4D REST API address"},{"key":"basicAuthUsername","value":"bruno","type":"any","description":"P4D Username to use when connecting to the REST API"},{"key":"basicAuthPassword","value":"","type":"any","description":"The user's P4D ticket is used as the password for basic authentication"},{"key":"TICKET","value":"","type":"any","description":"P4D Server ticket generated by `p4 login -a -p`"},{"key":"HOSTNAME","value":"localhost","type":"any","description":"P4D web server address"},{"key":"PORT","value":"8443","type":"any","description":"P4D web server port"}]}