github.com/rpdict/ponzu@v0.10.1-0.20190226054626-477f29d6bf5e/docs/build/HTTP-APIs/Content/index.html (about) 1 2 <!DOCTYPE html> 3 <html lang="en" class="no-js"> 4 <head> 5 6 <meta charset="utf-8"> 7 <meta name="viewport" content="width=device-width,initial-scale=1"> 8 9 10 11 12 <link rel="shortcut icon" href="../../assets/images/favicon.png"> 13 14 <meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.6.1"> 15 16 17 18 <title>Content HTTP API</title> 19 20 21 22 <script src="../../assets/javascripts/modernizr-56ade86843.js"></script> 23 24 25 <link rel="stylesheet" href="../../assets/stylesheets/application-4d0d3f2fbf.css"> 26 27 <link rel="stylesheet" href="../../assets/stylesheets/application-f78e5cb881.palette.css"> 28 29 30 31 32 33 34 35 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono"> 36 <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style> 37 38 <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons"> 39 40 41 42 </head> 43 44 45 46 47 <body data-md-color-primary="grey" data-md-color-accent="light-blue"> 48 49 <svg class="md-svg"> 50 <defs> 51 52 53 <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg> 54 55 </defs> 56 </svg> 57 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="drawer"> 58 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="search"> 59 <label class="md-overlay" data-md-component="overlay" for="drawer"></label> 60 61 <header class="md-header" data-md-component="header"> 62 <nav class="md-header-nav md-grid"> 63 <div class="md-flex"> 64 <div class="md-flex__cell md-flex__cell--shrink"> 65 66 <a href="../.." title="Ponzu" class="md-logo md-header-nav__button"> 67 <img src="../../images/logo.png" width="24" height="24"> 68 </a> 69 70 </div> 71 <div class="md-flex__cell md-flex__cell--shrink"> 72 <label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label> 73 </div> 74 <div class="md-flex__cell md-flex__cell--stretch"> 75 <span class="md-flex__ellipsis md-header-nav__title"> 76 77 78 79 <span class="md-header-nav__parent"> 80 HTTP APIs 81 </span> 82 83 84 Content 85 86 </span> 87 </div> 88 <div class="md-flex__cell md-flex__cell--shrink"> 89 90 <label class="md-icon md-icon--search md-header-nav__button" for="search"></label> 91 92 <div class="md-search" data-md-component="search"> 93 <label class="md-search__overlay" for="search"></label> 94 <div class="md-search__inner"> 95 <form class="md-search__form" name="search"> 96 <input type="text" class="md-search__input" name="query" required placeholder="Search" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query"> 97 <label class="md-icon md-search__icon" for="search"></label> 98 <button type="reset" class="md-icon md-search__icon" data-md-component="reset">close</button> 99 </form> 100 <div class="md-search__output"> 101 <div class="md-search__scrollwrap" data-md-scrollfix> 102 <div class="md-search-result" data-md-component="result"> 103 <div class="md-search-result__meta" data-md-lang-result-none="No matching documents" data-md-lang-result-one="1 matching document" data-md-lang-result-other="# matching documents"> 104 Type to start searching 105 </div> 106 <ol class="md-search-result__list"></ol> 107 </div> 108 </div> 109 </div> 110 </div> 111 </div> 112 113 </div> 114 <div class="md-flex__cell md-flex__cell--shrink"> 115 <div class="md-header-nav__source"> 116 117 118 119 120 121 122 123 <a href="https://github.com/rpdict/ponzu" title="Go to repository" class="md-source" data-md-source="github"> 124 125 <div class="md-source__icon"> 126 <svg viewBox="0 0 24 24" width="24" height="24"> 127 <use xlink:href="#github" width="24" height="24"></use> 128 </svg> 129 </div> 130 131 <div class="md-source__repository"> 132 ponzu-cms/ponzu 133 </div> 134 </a> 135 136 137 </div> 138 </div> 139 </div> 140 </nav> 141 </header> 142 143 <div class="md-container"> 144 145 146 <main class="md-main"> 147 <div class="md-main__inner md-grid" data-md-component="container"> 148 149 150 <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> 151 <div class="md-sidebar__scrollwrap"> 152 <div class="md-sidebar__inner"> 153 <nav class="md-nav md-nav--primary" data-md-level="0"> 154 <label class="md-nav__title md-nav__title--site" for="drawer"> 155 156 <i class="md-logo md-nav__button"> 157 <img src="../../images/logo.png"> 158 </i> 159 160 Ponzu 161 </label> 162 163 <div class="md-nav__source"> 164 165 166 167 168 169 170 <a href="https://github.com/rpdict/ponzu" title="Go to repository" class="md-source" data-md-source="github"> 171 172 <div class="md-source__icon"> 173 <svg viewBox="0 0 24 24" width="24" height="24"> 174 <use xlink:href="#github" width="24" height="24"></use> 175 </svg> 176 </div> 177 178 <div class="md-source__repository"> 179 ponzu-cms/ponzu 180 </div> 181 </a> 182 183 </div> 184 185 <ul class="md-nav__list" data-md-scrollfix> 186 187 188 189 190 191 192 <li class="md-nav__item"> 193 <a href="../.." title="Home" class="md-nav__link"> 194 Home 195 </a> 196 </li> 197 198 199 200 201 202 203 204 <li class="md-nav__item md-nav__item--nested"> 205 206 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2"> 207 208 <label class="md-nav__link" for="nav-2"> 209 CLI 210 </label> 211 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 212 <label class="md-nav__title" for="nav-2"> 213 CLI 214 </label> 215 <ul class="md-nav__list" data-md-scrollfix> 216 217 218 219 220 221 222 223 <li class="md-nav__item"> 224 <a href="../../CLI/General-Usage/" title="General Usage" class="md-nav__link"> 225 General Usage 226 </a> 227 </li> 228 229 230 231 232 233 234 235 <li class="md-nav__item"> 236 <a href="../../CLI/Generating-References/" title="Generating References" class="md-nav__link"> 237 Generating References 238 </a> 239 </li> 240 241 242 </ul> 243 </nav> 244 </li> 245 246 247 248 249 250 251 252 <li class="md-nav__item md-nav__item--nested"> 253 254 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3"> 255 256 <label class="md-nav__link" for="nav-3"> 257 Content 258 </label> 259 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 260 <label class="md-nav__title" for="nav-3"> 261 Content 262 </label> 263 <ul class="md-nav__list" data-md-scrollfix> 264 265 266 267 268 269 270 271 <li class="md-nav__item"> 272 <a href="../../Content/An-Overview/" title="An Overview" class="md-nav__link"> 273 An Overview 274 </a> 275 </li> 276 277 278 279 280 281 282 283 <li class="md-nav__item"> 284 <a href="../../Content/Extending-Content/" title="Extending Content" class="md-nav__link"> 285 Extending Content 286 </a> 287 </li> 288 289 290 </ul> 291 </nav> 292 </li> 293 294 295 296 297 298 299 300 <li class="md-nav__item md-nav__item--nested"> 301 302 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4"> 303 304 <label class="md-nav__link" for="nav-4"> 305 Form Fields 306 </label> 307 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 308 <label class="md-nav__title" for="nav-4"> 309 Form Fields 310 </label> 311 <ul class="md-nav__list" data-md-scrollfix> 312 313 314 315 316 317 318 319 <li class="md-nav__item"> 320 <a href="../../Form-Fields/HTML-Inputs/" title="HTML Inputs" class="md-nav__link"> 321 HTML Inputs 322 </a> 323 </li> 324 325 326 </ul> 327 </nav> 328 </li> 329 330 331 332 333 334 335 336 337 338 <li class="md-nav__item md-nav__item--active md-nav__item--nested"> 339 340 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked> 341 342 <label class="md-nav__link" for="nav-5"> 343 HTTP APIs 344 </label> 345 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 346 <label class="md-nav__title" for="nav-5"> 347 HTTP APIs 348 </label> 349 <ul class="md-nav__list" data-md-scrollfix> 350 351 352 353 354 355 356 357 358 359 <li class="md-nav__item md-nav__item--active"> 360 361 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="toc"> 362 363 364 <label class="md-nav__link md-nav__link--active" for="toc"> 365 Content 366 </label> 367 368 <a href="./" title="Content" class="md-nav__link md-nav__link--active"> 369 Content 370 </a> 371 372 373 <nav class="md-nav md-nav--secondary"> 374 375 376 377 <label class="md-nav__title" for="toc">Table of contents</label> 378 <ul class="md-nav__list" data-md-scrollfix> 379 380 <li class="md-nav__item"> 381 <a href="#endpoints" title="Endpoints" class="md-nav__link"> 382 Endpoints 383 </a> 384 385 <nav class="md-nav"> 386 <ul class="md-nav__list"> 387 388 <li class="md-nav__item"> 389 <a href="#get-content-by-type" title="Get Content by Type" class="md-nav__link"> 390 Get Content by Type 391 </a> 392 393 <nav class="md-nav"> 394 <ul class="md-nav__list"> 395 396 <li class="md-nav__item"> 397 <a href="#sample-response" title="Sample Response" class="md-nav__link"> 398 Sample Response 399 </a> 400 401 </li> 402 403 </ul> 404 </nav> 405 406 </li> 407 408 <li class="md-nav__item"> 409 <a href="#get-contents-by-type" title="Get Contents by Type" class="md-nav__link"> 410 Get Contents by Type 411 </a> 412 413 <nav class="md-nav"> 414 <ul class="md-nav__list"> 415 416 <li class="md-nav__item"> 417 <a href="#sample-response_1" title="Sample Response" class="md-nav__link"> 418 Sample Response 419 </a> 420 421 </li> 422 423 </ul> 424 </nav> 425 426 </li> 427 428 <li class="md-nav__item"> 429 <a href="#get-content-by-slug" title="Get Content by Slug" class="md-nav__link"> 430 Get Content by Slug 431 </a> 432 433 <nav class="md-nav"> 434 <ul class="md-nav__list"> 435 436 <li class="md-nav__item"> 437 <a href="#sample-response_2" title="Sample Response" class="md-nav__link"> 438 Sample Response 439 </a> 440 441 </li> 442 443 </ul> 444 </nav> 445 446 </li> 447 448 <li class="md-nav__item"> 449 <a href="#new-content" title="New Content" class="md-nav__link"> 450 New Content 451 </a> 452 453 <nav class="md-nav"> 454 <ul class="md-nav__list"> 455 456 <li class="md-nav__item"> 457 <a href="#sample-response_3" title="Sample Response" class="md-nav__link"> 458 Sample Response 459 </a> 460 461 </li> 462 463 </ul> 464 </nav> 465 466 </li> 467 468 <li class="md-nav__item"> 469 <a href="#update-content" title="Update Content" class="md-nav__link"> 470 Update Content 471 </a> 472 473 <nav class="md-nav"> 474 <ul class="md-nav__list"> 475 476 <li class="md-nav__item"> 477 <a href="#sample-response_4" title="Sample Response" class="md-nav__link"> 478 Sample Response 479 </a> 480 481 </li> 482 483 </ul> 484 </nav> 485 486 </li> 487 488 <li class="md-nav__item"> 489 <a href="#delete-content" title="Delete Content" class="md-nav__link"> 490 Delete Content 491 </a> 492 493 <nav class="md-nav"> 494 <ul class="md-nav__list"> 495 496 <li class="md-nav__item"> 497 <a href="#sample-response_5" title="Sample Response" class="md-nav__link"> 498 Sample Response 499 </a> 500 501 </li> 502 503 </ul> 504 </nav> 505 506 </li> 507 508 <li class="md-nav__item"> 509 <a href="#additional-information" title="Additional Information" class="md-nav__link"> 510 Additional Information 511 </a> 512 513 <nav class="md-nav"> 514 <ul class="md-nav__list"> 515 516 <li class="md-nav__item"> 517 <a href="#response-headers" title="Response Headers" class="md-nav__link"> 518 Response Headers 519 </a> 520 521 <nav class="md-nav"> 522 <ul class="md-nav__list"> 523 524 <li class="md-nav__item"> 525 <a href="#http11" title="HTTP/1.1" class="md-nav__link"> 526 HTTP/1.1 527 </a> 528 529 </li> 530 531 <li class="md-nav__item"> 532 <a href="#http2" title="HTTP/2" class="md-nav__link"> 533 HTTP/2 534 </a> 535 536 </li> 537 538 </ul> 539 </nav> 540 541 </li> 542 543 <li class="md-nav__item"> 544 <a href="#helpful-links" title="Helpful links" class="md-nav__link"> 545 Helpful links 546 </a> 547 548 </li> 549 550 </ul> 551 </nav> 552 553 </li> 554 555 </ul> 556 </nav> 557 558 </li> 559 560 561 562 </ul> 563 564 </nav> 565 566 </li> 567 568 569 570 571 572 573 574 <li class="md-nav__item"> 575 <a href="../File-Metadata/" title="File Metadata" class="md-nav__link"> 576 File Metadata 577 </a> 578 </li> 579 580 581 582 583 584 585 586 <li class="md-nav__item"> 587 <a href="../Search/" title="Search" class="md-nav__link"> 588 Search 589 </a> 590 </li> 591 592 593 </ul> 594 </nav> 595 </li> 596 597 598 599 600 601 602 603 <li class="md-nav__item md-nav__item--nested"> 604 605 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6"> 606 607 <label class="md-nav__link" for="nav-6"> 608 Interfaces 609 </label> 610 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 611 <label class="md-nav__title" for="nav-6"> 612 Interfaces 613 </label> 614 <ul class="md-nav__list" data-md-scrollfix> 615 616 617 618 619 620 621 622 <li class="md-nav__item"> 623 <a href="../../Interfaces/API/" title="API" class="md-nav__link"> 624 API 625 </a> 626 </li> 627 628 629 630 631 632 633 634 <li class="md-nav__item"> 635 <a href="../../Interfaces/Editor/" title="Editor" class="md-nav__link"> 636 Editor 637 </a> 638 </li> 639 640 641 642 643 644 645 646 <li class="md-nav__item"> 647 <a href="../../Interfaces/Format/" title="Format" class="md-nav__link"> 648 Format 649 </a> 650 </li> 651 652 653 654 655 656 657 658 <li class="md-nav__item"> 659 <a href="../../Interfaces/Item/" title="Item" class="md-nav__link"> 660 Item 661 </a> 662 </li> 663 664 665 666 667 668 669 670 <li class="md-nav__item"> 671 <a href="../../Interfaces/Search/" title="Search" class="md-nav__link"> 672 Search 673 </a> 674 </li> 675 676 677 </ul> 678 </nav> 679 </li> 680 681 682 683 684 685 686 687 <li class="md-nav__item md-nav__item--nested"> 688 689 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7"> 690 691 <label class="md-nav__link" for="nav-7"> 692 Ponzu Addons 693 </label> 694 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 695 <label class="md-nav__title" for="nav-7"> 696 Ponzu Addons 697 </label> 698 <ul class="md-nav__list" data-md-scrollfix> 699 700 701 702 703 704 705 706 <li class="md-nav__item"> 707 <a href="../../Ponzu-Addons/Creating-Addons/" title="Creating Addons" class="md-nav__link"> 708 Creating Addons 709 </a> 710 </li> 711 712 713 714 715 716 717 718 <li class="md-nav__item"> 719 <a href="../../Ponzu-Addons/Using-Addons/" title="Using Addons" class="md-nav__link"> 720 Using Addons 721 </a> 722 </li> 723 724 725 </ul> 726 </nav> 727 </li> 728 729 730 731 732 733 734 735 <li class="md-nav__item md-nav__item--nested"> 736 737 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8"> 738 739 <label class="md-nav__link" for="nav-8"> 740 Quickstart 741 </label> 742 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 743 <label class="md-nav__title" for="nav-8"> 744 Quickstart 745 </label> 746 <ul class="md-nav__list" data-md-scrollfix> 747 748 749 750 751 752 753 754 <li class="md-nav__item"> 755 <a href="../../Quickstart/Overview/" title="Overview" class="md-nav__link"> 756 Overview 757 </a> 758 </li> 759 760 761 </ul> 762 </nav> 763 </li> 764 765 766 767 768 769 770 771 <li class="md-nav__item md-nav__item--nested"> 772 773 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9"> 774 775 <label class="md-nav__link" for="nav-9"> 776 References 777 </label> 778 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 779 <label class="md-nav__title" for="nav-9"> 780 References 781 </label> 782 <ul class="md-nav__list" data-md-scrollfix> 783 784 785 786 787 788 789 790 <li class="md-nav__item"> 791 <a href="../../References/Overview/" title="Overview" class="md-nav__link"> 792 Overview 793 </a> 794 </li> 795 796 797 </ul> 798 </nav> 799 </li> 800 801 802 803 804 805 806 807 <li class="md-nav__item md-nav__item--nested"> 808 809 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10"> 810 811 <label class="md-nav__link" for="nav-10"> 812 Running Backups 813 </label> 814 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 815 <label class="md-nav__title" for="nav-10"> 816 Running Backups 817 </label> 818 <ul class="md-nav__list" data-md-scrollfix> 819 820 821 822 823 824 825 826 <li class="md-nav__item"> 827 <a href="../../Running-Backups/Backups/" title="Backups" class="md-nav__link"> 828 Backups 829 </a> 830 </li> 831 832 833 </ul> 834 </nav> 835 </li> 836 837 838 839 840 841 842 843 <li class="md-nav__item md-nav__item--nested"> 844 845 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-11" type="checkbox" id="nav-11"> 846 847 <label class="md-nav__link" for="nav-11"> 848 System Configuration 849 </label> 850 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 851 <label class="md-nav__title" for="nav-11"> 852 System Configuration 853 </label> 854 <ul class="md-nav__list" data-md-scrollfix> 855 856 857 858 859 860 861 862 <li class="md-nav__item"> 863 <a href="../../System-Configuration/Settings/" title="Settings" class="md-nav__link"> 864 Settings 865 </a> 866 </li> 867 868 869 </ul> 870 </nav> 871 </li> 872 873 874 875 876 877 878 879 <li class="md-nav__item md-nav__item--nested"> 880 881 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-12" type="checkbox" id="nav-12"> 882 883 <label class="md-nav__link" for="nav-12"> 884 System Deployment 885 </label> 886 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 887 <label class="md-nav__title" for="nav-12"> 888 System Deployment 889 </label> 890 <ul class="md-nav__list" data-md-scrollfix> 891 892 893 894 895 896 897 898 <li class="md-nav__item"> 899 <a href="../../System-Deployment/Docker/" title="Docker" class="md-nav__link"> 900 Docker 901 </a> 902 </li> 903 904 905 906 907 908 909 910 <li class="md-nav__item"> 911 <a href="../../System-Deployment/SysV-Style/" title="SysV Style" class="md-nav__link"> 912 SysV Style 913 </a> 914 </li> 915 916 917 </ul> 918 </nav> 919 </li> 920 921 922 </ul> 923 </nav> 924 </div> 925 </div> 926 </div> 927 928 929 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> 930 <div class="md-sidebar__scrollwrap"> 931 <div class="md-sidebar__inner"> 932 933 <nav class="md-nav md-nav--secondary"> 934 935 936 937 <label class="md-nav__title" for="toc">Table of contents</label> 938 <ul class="md-nav__list" data-md-scrollfix> 939 940 <li class="md-nav__item"> 941 <a href="#endpoints" title="Endpoints" class="md-nav__link"> 942 Endpoints 943 </a> 944 945 <nav class="md-nav"> 946 <ul class="md-nav__list"> 947 948 <li class="md-nav__item"> 949 <a href="#get-content-by-type" title="Get Content by Type" class="md-nav__link"> 950 Get Content by Type 951 </a> 952 953 <nav class="md-nav"> 954 <ul class="md-nav__list"> 955 956 <li class="md-nav__item"> 957 <a href="#sample-response" title="Sample Response" class="md-nav__link"> 958 Sample Response 959 </a> 960 961 </li> 962 963 </ul> 964 </nav> 965 966 </li> 967 968 <li class="md-nav__item"> 969 <a href="#get-contents-by-type" title="Get Contents by Type" class="md-nav__link"> 970 Get Contents by Type 971 </a> 972 973 <nav class="md-nav"> 974 <ul class="md-nav__list"> 975 976 <li class="md-nav__item"> 977 <a href="#sample-response_1" title="Sample Response" class="md-nav__link"> 978 Sample Response 979 </a> 980 981 </li> 982 983 </ul> 984 </nav> 985 986 </li> 987 988 <li class="md-nav__item"> 989 <a href="#get-content-by-slug" title="Get Content by Slug" class="md-nav__link"> 990 Get Content by Slug 991 </a> 992 993 <nav class="md-nav"> 994 <ul class="md-nav__list"> 995 996 <li class="md-nav__item"> 997 <a href="#sample-response_2" title="Sample Response" class="md-nav__link"> 998 Sample Response 999 </a> 1000 1001 </li> 1002 1003 </ul> 1004 </nav> 1005 1006 </li> 1007 1008 <li class="md-nav__item"> 1009 <a href="#new-content" title="New Content" class="md-nav__link"> 1010 New Content 1011 </a> 1012 1013 <nav class="md-nav"> 1014 <ul class="md-nav__list"> 1015 1016 <li class="md-nav__item"> 1017 <a href="#sample-response_3" title="Sample Response" class="md-nav__link"> 1018 Sample Response 1019 </a> 1020 1021 </li> 1022 1023 </ul> 1024 </nav> 1025 1026 </li> 1027 1028 <li class="md-nav__item"> 1029 <a href="#update-content" title="Update Content" class="md-nav__link"> 1030 Update Content 1031 </a> 1032 1033 <nav class="md-nav"> 1034 <ul class="md-nav__list"> 1035 1036 <li class="md-nav__item"> 1037 <a href="#sample-response_4" title="Sample Response" class="md-nav__link"> 1038 Sample Response 1039 </a> 1040 1041 </li> 1042 1043 </ul> 1044 </nav> 1045 1046 </li> 1047 1048 <li class="md-nav__item"> 1049 <a href="#delete-content" title="Delete Content" class="md-nav__link"> 1050 Delete Content 1051 </a> 1052 1053 <nav class="md-nav"> 1054 <ul class="md-nav__list"> 1055 1056 <li class="md-nav__item"> 1057 <a href="#sample-response_5" title="Sample Response" class="md-nav__link"> 1058 Sample Response 1059 </a> 1060 1061 </li> 1062 1063 </ul> 1064 </nav> 1065 1066 </li> 1067 1068 <li class="md-nav__item"> 1069 <a href="#additional-information" title="Additional Information" class="md-nav__link"> 1070 Additional Information 1071 </a> 1072 1073 <nav class="md-nav"> 1074 <ul class="md-nav__list"> 1075 1076 <li class="md-nav__item"> 1077 <a href="#response-headers" title="Response Headers" class="md-nav__link"> 1078 Response Headers 1079 </a> 1080 1081 <nav class="md-nav"> 1082 <ul class="md-nav__list"> 1083 1084 <li class="md-nav__item"> 1085 <a href="#http11" title="HTTP/1.1" class="md-nav__link"> 1086 HTTP/1.1 1087 </a> 1088 1089 </li> 1090 1091 <li class="md-nav__item"> 1092 <a href="#http2" title="HTTP/2" class="md-nav__link"> 1093 HTTP/2 1094 </a> 1095 1096 </li> 1097 1098 </ul> 1099 </nav> 1100 1101 </li> 1102 1103 <li class="md-nav__item"> 1104 <a href="#helpful-links" title="Helpful links" class="md-nav__link"> 1105 Helpful links 1106 </a> 1107 1108 </li> 1109 1110 </ul> 1111 </nav> 1112 1113 </li> 1114 1115 </ul> 1116 </nav> 1117 1118 </li> 1119 1120 1121 1122 </ul> 1123 1124 </nav> 1125 </div> 1126 </div> 1127 </div> 1128 1129 1130 <div class="md-content"> 1131 <article class="md-content__inner md-typeset"> 1132 1133 1134 1135 <h1>Content</h1> 1136 1137 <p>Ponzu provides a read & write HTTP API to access and interact with content on a 1138 system. By default, write access (including create, update and delete) and search 1139 are disabled. See the section on Ponzu's <a href="../../Interfaces/API">API Interfaces</a> to learn 1140 more about how to enable these endpoints.</p> 1141 <hr /> 1142 <h2 id="endpoints">Endpoints<a class="headerlink" href="#endpoints" title="Permanent link">¶</a></h2> 1143 <h3 id="get-content-by-type">Get Content by Type<a class="headerlink" href="#get-content-by-type" title="Permanent link">¶</a></h3> 1144 <p><kbd>GET</kbd> <code>/api/content?type=<Type>&id=<ID></code></p> 1145 <h5 id="sample-response">Sample Response<a class="headerlink" href="#sample-response" title="Permanent link">¶</a></h5> 1146 <div class="codehilite"><pre><span></span><span class="p">{</span> 1147 <span class="s2">"data"</span><span class="o">:</span> <span class="p">[</span> 1148 <span class="p">{</span> 1149 <span class="s2">"uuid"</span><span class="o">:</span> <span class="s2">"024a5797-e064-4ee0-abe3-415cb6d3ed18"</span><span class="p">,</span> 1150 <span class="s2">"id"</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span> 1151 <span class="s2">"slug"</span><span class="o">:</span> <span class="s2">"item-id-024a5797-e064-4ee0-abe3-415cb6d3ed18"</span> <span class="c1">// customizable</span> 1152 <span class="s2">"timestamp"</span><span class="o">:</span> <span class="mi">1493926453826</span><span class="p">,</span> <span class="c1">// milliseconds since Unix epoch</span> 1153 <span class="s2">"updated"</span><span class="o">:</span> <span class="mi">1493926453826</span><span class="p">,</span> 1154 <span class="c1">// your content data...,</span> 1155 <span class="p">}</span> 1156 <span class="p">]</span> 1157 <span class="p">}</span> 1158 </pre></div> 1159 1160 1161 <hr /> 1162 <h3 id="get-contents-by-type">Get Contents by Type<a class="headerlink" href="#get-contents-by-type" title="Permanent link">¶</a></h3> 1163 <p><kbd>GET</kbd> <code>/api/contents?type=<Type></code></p> 1164 <ul> 1165 <li>optional params:<ol> 1166 <li><code>order</code> (string: ASC / DESC, default: DESC)</li> 1167 <li><code>count</code> (int: -1 - N, default: 10, -1 returns all)</li> 1168 <li><code>offset</code> (int: 0 - N, default: 0)</li> 1169 </ol> 1170 </li> 1171 </ul> 1172 <h5 id="sample-response_1">Sample Response<a class="headerlink" href="#sample-response_1" title="Permanent link">¶</a></h5> 1173 <div class="codehilite"><pre><span></span><span class="p">{</span> 1174 <span class="s2">"data"</span><span class="o">:</span> <span class="p">[</span> 1175 <span class="p">{</span> 1176 <span class="s2">"uuid"</span><span class="o">:</span> <span class="s2">"024a5797-e064-4ee0-abe3-415cb6d3ed18"</span><span class="p">,</span> 1177 <span class="s2">"id"</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span> 1178 <span class="s2">"slug"</span><span class="o">:</span> <span class="s2">"item-id-024a5797-e064-4ee0-abe3-415cb6d3ed18"</span><span class="p">,</span> <span class="c1">// customizable</span> 1179 <span class="s2">"timestamp"</span><span class="o">:</span> <span class="mi">1493926453826</span><span class="p">,</span> <span class="c1">// milliseconds since Unix epoch</span> 1180 <span class="s2">"updated"</span><span class="o">:</span> <span class="mi">1493926453826</span><span class="p">,</span> 1181 <span class="c1">// your content data...,</span> 1182 <span class="p">},</span> 1183 <span class="p">{</span> 1184 <span class="s2">"uuid"</span><span class="o">:</span> <span class="s2">"5a9177c7-634d-4fb1-88a6-ef6c45de797c"</span><span class="p">,</span> 1185 <span class="s2">"id"</span><span class="o">:</span> <span class="mi">7</span><span class="p">,</span> 1186 <span class="s2">"slug"</span><span class="o">:</span> <span class="s2">"item-id-5a9177c7-634d-4fb1-88a6-ef6c45de797c"</span><span class="p">,</span> <span class="c1">// customizable</span> 1187 <span class="s2">"timestamp"</span><span class="o">:</span> <span class="mi">1493926453826</span><span class="p">,</span> <span class="c1">// milliseconds since Unix epoch</span> 1188 <span class="s2">"updated"</span><span class="o">:</span> <span class="mi">1493926453826</span><span class="p">,</span> 1189 <span class="c1">// your content data...,</span> 1190 <span class="p">},</span> 1191 <span class="c1">// more objects...</span> 1192 <span class="p">]</span> 1193 <span class="p">}</span> 1194 </pre></div> 1195 1196 1197 <hr /> 1198 <h3 id="get-content-by-slug">Get Content by Slug<a class="headerlink" href="#get-content-by-slug" title="Permanent link">¶</a></h3> 1199 <p><kbd>GET</kbd> <code>/api/content?slug=<Slug></code></p> 1200 <h5 id="sample-response_2">Sample Response<a class="headerlink" href="#sample-response_2" title="Permanent link">¶</a></h5> 1201 <div class="codehilite"><pre><span></span><span class="p">{</span> 1202 <span class="s2">"data"</span><span class="o">:</span> <span class="p">[</span> 1203 <span class="p">{</span> 1204 <span class="s2">"uuid"</span><span class="o">:</span> <span class="s2">"024a5797-e064-4ee0-abe3-415cb6d3ed18"</span><span class="p">,</span> 1205 <span class="s2">"id"</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span> 1206 <span class="s2">"slug"</span><span class="o">:</span> <span class="s2">"item-id-024a5797-e064-4ee0-abe3-415cb6d3ed18"</span><span class="p">,</span> <span class="c1">// customizable</span> 1207 <span class="s2">"timestamp"</span><span class="o">:</span> <span class="mi">1493926453826</span><span class="p">,</span> <span class="c1">// milliseconds since Unix epoch</span> 1208 <span class="s2">"updated"</span><span class="o">:</span> <span class="mi">1493926453826</span><span class="p">,</span> 1209 <span class="c1">// your content data...,</span> 1210 <span class="p">}</span> 1211 <span class="p">]</span> 1212 <span class="p">}</span> 1213 </pre></div> 1214 1215 1216 <hr /> 1217 <h3 id="new-content">New Content<a class="headerlink" href="#new-content" title="Permanent link">¶</a></h3> 1218 <p><kbd>POST</kbd> <code>/api/content/create?type=<Type></code></p> 1219 <div class="admonition note"> 1220 <p class="admonition-title">Request Data Encoding</p> 1221 <p>Request must be <code>multipart/form-data</code> encoded. If not, a <code>400 Bad Request</code> 1222 Response will be returned.</p> 1223 </div> 1224 <h5 id="sample-response_3">Sample Response<a class="headerlink" href="#sample-response_3" title="Permanent link">¶</a></h5> 1225 <div class="codehilite"><pre><span></span><span class="p">{</span> 1226 <span class="s2">"data"</span><span class="o">:</span> <span class="p">[</span> 1227 <span class="p">{</span> 1228 <span class="s2">"id"</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span> <span class="c1">// will be omitted if status is pending</span> 1229 <span class="s2">"type"</span><span class="o">:</span> <span class="s2">"Review"</span><span class="p">,</span> 1230 <span class="s2">"status"</span><span class="o">:</span> <span class="s2">"public"</span> 1231 <span class="p">}</span> 1232 <span class="p">]</span> 1233 <span class="p">}</span> 1234 </pre></div> 1235 1236 1237 <hr /> 1238 <h3 id="update-content">Update Content<a class="headerlink" href="#update-content" title="Permanent link">¶</a></h3> 1239 <p><kbd>POST</kbd> <code>/api/content/update?type=<Type>&id=<id></code></p> 1240 <div class="admonition note"> 1241 <p class="admonition-title">Request Data Encoding</p> 1242 <p>Request must be <code>multipart/form-data</code> encoded. If not, a <code>400 Bad Request</code> 1243 Response will be returned.</p> 1244 </div> 1245 <h5 id="sample-response_4">Sample Response<a class="headerlink" href="#sample-response_4" title="Permanent link">¶</a></h5> 1246 <div class="codehilite"><pre><span></span><span class="p">{</span> 1247 <span class="s2">"data"</span><span class="o">:</span> <span class="p">[</span> 1248 <span class="p">{</span> 1249 <span class="s2">"id"</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span> 1250 <span class="s2">"type"</span><span class="o">:</span> <span class="s2">"Review"</span><span class="p">,</span> 1251 <span class="s2">"status"</span><span class="o">:</span> <span class="s2">"public"</span> 1252 <span class="p">}</span> 1253 <span class="p">]</span> 1254 <span class="p">}</span> 1255 </pre></div> 1256 1257 1258 <hr /> 1259 <h3 id="delete-content">Delete Content<a class="headerlink" href="#delete-content" title="Permanent link">¶</a></h3> 1260 <p><kbd>POST</kbd> <code>/api/content/delete?type=<Type>&id=<id></code></p> 1261 <div class="admonition note"> 1262 <p class="admonition-title">Request Data Encoding</p> 1263 <p>Request must be <code>multipart/form-data</code> encoded. If not, a <code>400 Bad Request</code> 1264 Response will be returned.</p> 1265 </div> 1266 <h5 id="sample-response_5">Sample Response<a class="headerlink" href="#sample-response_5" title="Permanent link">¶</a></h5> 1267 <div class="codehilite"><pre><span></span><span class="p">{</span> 1268 <span class="s2">"data"</span><span class="o">:</span> <span class="p">[</span> 1269 <span class="p">{</span> 1270 <span class="s2">"id"</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span> 1271 <span class="s2">"type"</span><span class="o">:</span> <span class="s2">"Review"</span><span class="p">,</span> 1272 <span class="s2">"status"</span><span class="o">:</span> <span class="s2">"deleted"</span> 1273 <span class="p">}</span> 1274 <span class="p">]</span> 1275 <span class="p">}</span> 1276 </pre></div> 1277 1278 1279 <hr /> 1280 <h3 id="additional-information">Additional Information<a class="headerlink" href="#additional-information" title="Permanent link">¶</a></h3> 1281 <p>All API endpoints are CORS-enabled (can be disabled in configuration at run-time) and API requests are recorded by your system to generate graphs of total requests and unique client requests within the Admin dashboard.</p> 1282 <h4 id="response-headers">Response Headers<a class="headerlink" href="#response-headers" title="Permanent link">¶</a></h4> 1283 <p>The following headers are common across all Ponzu API responses. Some of them can be modified 1284 in the <a href="../../System-Configuration/Settings">system configuration</a> while your system is running.</p> 1285 <h5 id="http11">HTTP/1.1<a class="headerlink" href="#http11" title="Permanent link">¶</a></h5> 1286 <div class="codehilite"><pre><span></span>HTTP/1.1 200 OK 1287 Access-Control-Allow-Headers: Accept, Authorization, Content-Type 1288 Access-Control-Allow-Origin: * 1289 Cache-Control: max-age=2592000, public 1290 Content-Encoding: gzip 1291 Content-Type: application/json 1292 Etag: MTQ5Mzk0NTYzNQ== 1293 Vary: Accept-Encoding 1294 Date: Fri, 05 May 2017 01:15:49 GMT 1295 Content-Length: 199 1296 </pre></div> 1297 1298 1299 <h5 id="http2">HTTP/2<a class="headerlink" href="#http2" title="Permanent link">¶</a></h5> 1300 <div class="codehilite"><pre><span></span>access-control-allow-headers: Accept, Authorization, Content-Type 1301 access-control-allow-origin: * 1302 cache-control: max-age=2592000, public 1303 content-encoding: gzip 1304 content-length: 199 1305 content-type: application/json 1306 date: Fri, 05 May 2017 01:38:11 GMT 1307 etag: MTQ5Mzk0ODI4MA== 1308 status: 200 1309 vary: Accept-Encoding 1310 </pre></div> 1311 1312 1313 <h4 id="helpful-links">Helpful links<a class="headerlink" href="#helpful-links" title="Permanent link">¶</a></h4> 1314 <p><a href="https://github.com/natdm/typewriter">Typewriter</a> 1315 Generate & sync front-end data structures from Ponzu content types. (<a href="https://github.com/natdm/typewriter/blob/master/EXAMPLES.md#example-use-in-a-package-like-ponzu">Ponzu example</a>)</p> 1316 1317 1318 1319 1320 1321 1322 1323 </article> 1324 </div> 1325 </div> 1326 </main> 1327 1328 1329 <footer class="md-footer"> 1330 1331 <div class="md-footer-nav"> 1332 <nav class="md-footer-nav__inner md-grid"> 1333 1334 <a href="../../Form-Fields/HTML-Inputs/" title="HTML Inputs" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> 1335 <div class="md-flex__cell md-flex__cell--shrink"> 1336 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> 1337 </div> 1338 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> 1339 <span class="md-flex__ellipsis"> 1340 <span class="md-footer-nav__direction"> 1341 Previous 1342 </span> 1343 HTML Inputs 1344 </span> 1345 </div> 1346 </a> 1347 1348 1349 <a href="../File-Metadata/" title="File Metadata" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> 1350 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> 1351 <span class="md-flex__ellipsis"> 1352 <span class="md-footer-nav__direction"> 1353 Next 1354 </span> 1355 File Metadata 1356 </span> 1357 </div> 1358 <div class="md-flex__cell md-flex__cell--shrink"> 1359 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> 1360 </div> 1361 </a> 1362 1363 </nav> 1364 </div> 1365 1366 <div class="md-footer-meta md-typeset"> 1367 <div class="md-footer-meta__inner md-grid"> 1368 <div class="md-footer-copyright"> 1369 1370 powered by 1371 <a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a> 1372 and 1373 <a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs"> 1374 Material for MkDocs</a> 1375 </div> 1376 1377 1378 <div class="md-footer-social"> 1379 1380 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> 1381 1382 <a href="https://github.com/rpdict" class="md-footer-social__link fa fa-github"></a> 1383 1384 <a href="https://twitter.com/ponzu_cms" class="md-footer-social__link fa fa-twitter"></a> 1385 1386 </div> 1387 1388 1389 </div> 1390 </div> 1391 </footer> 1392 1393 </div> 1394 1395 <script src="../../assets/javascripts/application-6b599127bc.js"></script> 1396 <script>app.initialize({url:{base:"../.."}})</script> 1397 1398 1399 1400 1401 <script>!function(e,t,a,n,o,c,i){e.GoogleAnalyticsObject=o,e[o]=e[o]||function(){(e[o].q=e[o].q||[]).push(arguments)},e[o].l=1*new Date,c=t.createElement(a),i=t.getElementsByTagName(a)[0],c.async=1,c.src=n,i.parentNode.insertBefore(c,i)}(window,document,"script","https://www.google-analytics.com/analytics.js","ga"),ga("create","UA-98609560-1","auto"),ga("set","anonymizeIp",!0),ga("send","pageview");var links=document.getElementsByTagName("a");Array.prototype.map.call(links,function(e){e.host!=document.location.host&&e.addEventListener("click",function(){var t=e.getAttribute("data-md-action")||"follow";ga("send","event","outbound",t,e.href)})});var query=document.forms.search.query;query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})</script> 1402 1403 1404 </body> 1405 </html>