8000 Merge pull request #263 from github/add-user-agent-example · ostegott1/developer.github.com@0e851a8 · GitHub < 8000 meta name="twitter:title" content="Merge pull request #263 from github/add-user-agent-example · ostegott1/developer.github.com@0e851a8" />
[go: up one dir, main page]

Skip to content

Commit 0e851a8

Browse files
author
Jessica Lord
committed
Merge pull request github#263 from github/add-user-agent-example
User-Agent Example
2 parents 0a85f0b + 9f98f90 commit 0e851a8

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

content/v3.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -334,10 +334,15 @@ higher rate limit for your OAuth application.
334334

335335
## User Agent Required
336336

337-
All API requests MUST include a valid User Agent string. Requests with no User Agent
338-
string will be rejected. If you are hitting the API without authentication, we ask that
339-
you add some kind of identification to the UA header value. This is so we can contact
340-
you if there are problems.
337+
All API requests MUST include a valid `User-Agent` header. Requests with no `User-Agent`
338+
header will be rejected. We request that you use your GitHub username, or the name of your
339+
application, for the `User-Agent` header value. This allows us to contact you if there are problems.
340+
341+
Here's an example:
342+
343+
<pre class="terminal">
344+
User-Agent: Awesome-Octocat-App
345+
</pre>
341346

342347
## Conditional requests
343348

0 commit comments

Comments
 (0)
0